Grupo de Cliente
Descripción
El endpoint PostAddCustomerGroup es responsable del registro de un nuevo Grupo de Cliente en el sistema MIMS y puede ser visualizado en la pantalla CAD028.
Cómo registrar un nuevo grupo de cliente
Request HTTP Post
| Tipo de Solicitud | URL Ejemplo |
|---|---|
| POST | {{url_base}}/PostAddCustomerGroup |
| Ejemplo | http://suIPyPuerto/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 | Bandera que indica que los datos deben ser sobrescritos en caso de que el registro ya exista |
Retorno
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| WebServiceReturn | WebServiceReturn | Sí | Información 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 --request POST '{{url_base}}/PostAddCustomerGroup' \
--header 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{
"CustomerGroupNo": "CG001",
"Name": "Clientes Minoristas",
"OverwriteIfExists": true
}'
Ejemplo de Response
{
"WebServiceReturn": {
"Status": "wrsSuccess",
"ErrorCode": "",
"Message": "",
"Actor": "",
"ReturnQuestion": null
},
"CustomerGroupCode": 101
}
Exclusión de Grupo de Cliente
Descripción
El endpoint PostDeleteCustomerGroup ejecuta la exclusión de un Grupo de Cliente en el sistema MIMS.
Cómo excluir un Grupo de Cliente
Request HTTP Post
| Tipo de Solicitud | URL Ejemplo |
|---|---|
| POST | {{url_base}}/PostDeleteCustomerGroup |
| Ejemplo | http://suIPyPuerto/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 caso el grupo de cliente informado no exista en la base de datos |
Retorno
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| WebServiceReturn | WebServiceReturn | Sí | Información estándar de respuesta del Webservice en la ejecución del método |
Ejemplo de Request
curl --location --request POST '{{url_base}}/PostDeleteCustomerGroup' \
--header 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{
"CustomerGroupNo": "CG001",
"ErrorIfNotFound": true
}'
Ejemplo de Response
{
"WebServiceReturn": {
"Status": "wrsSuccess",
"ErrorCode": "",
"Message": "",
"Actor": "",
"ReturnQuestion": null
}
}