Grupo de Cliente
Registro de Grupo de Cliente
El endpoint PostAddCustomerGroup es responsable del registro de un nuevo Grupo de Cliente en el sistema MIMS. Este registro puede ser visualizado en la pantalla CAD028.
Cómo registrar un grupo de cliente
Request HTTP Post
| Tipo de Solicitud | URL Ejemplo |
|---|---|
| POST | {{url_base}}/PostAddCustomerGroup |
| Ejemplo | http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddCustomerGroup" |
Parámetros de Entrada
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| CustomerGroupNo | String(25) | Sí | Código externo del grupo de cliente |
| Name | String(40) | Sí | Descripción del grupo de cliente |
| OverwriteIfExists | Boolean | No | Flag que indica que los datos deben ser sobrescritos si el registro ya existe |
Retorno
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| WebServiceReturn | WebServiceReturn | Sí | Informaciones estándar de respuesta del WebService en la ejecución del método |
| CustomerGroupCode | Integer | Sí | Código interno del Grupo de Cliente generado en el sistema MIMS |
Ejemplo de Request
curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddCustomerGroup"' \
--header 'Content-Type: application/json' \
--data '{
"CustomerGroupNo": "CG001",
"Name": "Clientes Minorista",
"OverwriteIfExists": true
}'
Ejemplo de Response
{
"WebServiceReturn": {
"Status": "wrsSuccess",
"ErrorCode": "",
"Message": "",
"Actor": "",
"ReturnQuestion": null
},
"CustomerGroupCode": 4
}
🐞 Posibles Errores
| Código | Mensaje |
|---|---|
| ACG‑001 | ¡El parámetro Código Externo del Grupo de Cliente (CustomerGroupNo) informado ya existe! |
Eliminación de Grupo de Cliente
El endpoint PostDeleteCustomerGroup es responsable de ejecutar la eliminación de un Grupo de Cliente en el sistema MIMS.
Cómo eliminar un grupo de cliente
Request HTTP Post
| Tipo de Solicitud | URL Ejemplo |
|---|---|
| POST | {{url_base}}/PostDeleteCustomerGroup |
| Ejemplo | http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostDeleteCustomerGroup" |
Parámetros de Entrada
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| CustomerGroupNo | String(25) | Sí | Código externo del grupo de cliente |
| ErrorIfNotFound | Boolean | No | Retorna error si el grupo de cliente informado no existe en la base de datos |
Retorno
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| WebServiceReturn | WebServiceReturn | Sí | Informaciones estándar de respuesta del WebService en la ejecución del método |
Ejemplo de Request
curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostDeleteCustomerGroup"' \
--header 'Content-Type: application/json' \
--data '{
"CustomerGroupNo": "CG001",
"ErrorIfNotFound": false
}'
Ejemplo de Response
{
"WebServiceReturn": {
"Status": "wrsSuccess",
"ErrorCode": "",
"Message": "",
"Actor": "",
"ReturnQuestion": null
}
}
🐞 Posibles Errores
| Código | Mensaje |
|---|---|
| DCG‑001 | ¡El grupo de cliente informado pertenece a un cliente, por lo tanto no puede ser eliminado! |
| DCG‑002 | ¡El parámetro Código Externo del Grupo de Cliente (CustomerGroupNo) informado no fue encontrado! |