Saltar al contenido principal

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 SolicitudURL Ejemplo
POST{{url_base}}/PostAddCustomerGroup
Ejemplohttp://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddCustomerGroup"

Parámetros de Entrada​

ParámetroTipoObligatorioDescripción
CustomerGroupNoString(25)SíCódigo externo del grupo de cliente
NameString(40)SíDescripción del grupo de cliente
OverwriteIfExistsBooleanNoFlag que indica que los datos deben ser sobrescritos si el registro ya existe

Retorno​

ParámetroTipoObligatorioDescripción
WebServiceReturnWebServiceReturnSíInformaciones estándar de respuesta del WebService en la ejecución del método
CustomerGroupCodeIntegerSí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ódigoMensaje
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 SolicitudURL Ejemplo
POST{{url_base}}/PostDeleteCustomerGroup
Ejemplohttp://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostDeleteCustomerGroup"

Parámetros de Entrada​

ParámetroTipoObligatorioDescripción
CustomerGroupNoString(25)SíCódigo externo del grupo de cliente
ErrorIfNotFoundBooleanNoRetorna error si el grupo de cliente informado no existe en la base de datos

Retorno​

ParámetroTipoObligatorioDescripción
WebServiceReturnWebServiceReturnSí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ódigoMensaje
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!