Listado de contactos de un cliente
Esta función permite obtener un listado de todos los contactos de un cliente dado.
Parámetros de Entrada
Parámetro | Tipo | Descripción |
|---|---|---|
clientId CAMPO OBLIGATORIO | Integer | Identificador del cliente. |
activated | Boolean | Indica si el contacto está activado (tiene acceso al portal) o no. |
Parámetros de Salida
Parámetro | Tipo | Descripción |
|---|---|---|
contactId | Integer | Identificador del contacto. |
activatedId | Boolean | Indica si el contacto está activado (tiene acceso al portal) o no. |
String | Dirección de correo electrónico principal. | |
email2 | String | Dirección de correo electrónico 2. |
fax | String | Fax. |
mobile | String | Número de teléfono móvil. |
name | String | Nombre del contacto. |
phone | String | Teléfono. |
surname | String | Apellidos del contacto. |
Códigos Error
Código | Descripción |
|---|---|
1000 | Error genérico. |
3200 | Error obteniendo el listado de contactos. |
3201 | Error por falta de parámetros obligatorios. |
Ejemplos
Llamada (Método GET)
https://servidor:8443/calibry-rest-api/rest/cif/client/{clientId}/contacts
https://servidor:8443/calibry-rest-api/rest/cif/client/1/contacts
https://servidor:8443/calibry-rest-api/rest/cif/client/1/contacts?activated=true
Headers:
Authorization
Respuestas
Correcta:
[
{
"contactId": 5,
"name": "Juan",
"surname": "García",
"phone": "912223333",
"mobile": "687654321",
"fax": "912223344",
"email": "email1@dominio.com",
"email2": "email2@dominio.com",
"activated": false
}
]
Error:
{"code":"3200"}