Obtener artículos

Obtener artículos #

Obtiene los elementos de directorio que coincidan con el filtro proporcionado.

GET /v1.0/contactdirectories/{DIRECTORY_ID}/items?filter={FILTER}& campos={CAMPOS}

Hand Left warning
Recuerde URL Codifique los parámetros que se pasan en el archivo ' filtro' parámetro.
Document note
Al buscar en ' phoneX' campos, los números se almacenan en E.164 formato.

Ejemplo #

Esta solicitud consultará todos los elementos con un campo de teléfono que contenga +44XXXXXXXXXX

Color Wand tip
Las búsquedas se realizan mediante un CONTAINS consulta

Pedir # 

GET [https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items?filter%2B44XXXXXXXXXX=& campos=teléfono1& campos=teléfono2& campos=teléfono3& fields=phone4](https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items?filter%2B44XXXXXXXXXX=&fields=phone1&fields=phone2&fields=phone3&fields=phone4) HTTP/1.1
Autorización: portador {TOKEN}

Respuesta # 

HTTP/1.1 200 OK
Tipo de contenido: application/json; charset=utf-8
Longitud del contenido: xx
{
    "page_size": 1,
	"Datos": [ {
            "id": "00000000-0000-0000-0000-000000000123",
            "campos": {
                "title": "Sr",
                "fullName": "CRM2",
                "companyName": "Empresa",
                "jobTitle": "Título del trabajo",
                "phone1": "+44XXXXXXXXXX",
                "email": "Dirección de correo electrónico",
                "campo1": "campo1",
                "campo2": "campo2",
                "crmId": "00000000-0000-0000-0000-00000000000001"
            }
        }
    ][{
            "id": "00000000-0000-0000-0000-000000000123",
            "fields": {
                "title": "Mr",
                "fullName": "CRM2",
                "companyName": "Company",
                "jobTitle": "Job Title",
                "phone1": "+44XXXXXXXXXX",
                "email": "Email Address",
                "field1": "field1",
                "field2": "field2",
                "crmId": "00000000-0000-0000-0000-000000000001"
            }
        }
    ],
	"status": "éxito",
	"marca de tiempo": "2019-01-01T10:00:00.2890319Z"
}

Errores #

Desautorizado #

Cuando el token no se proporciona, no es válido o ha caducado 

HTTP/1.1 401 No autorizado

Mala solicitud #

Cuando el filtro o los campos proporcionados no están en el formato correcto 

HTTP/1.1 400 Solicitud incorrecta
Fecha: Thu, 06 Feb 2020 12:45:27 GMT
Tipo de contenido: application/json; charset=utf-8
Longitud del contenido: 149
{
	"error": 400,
	"message": "El valor '<directory id>' no es válido.",
	"status": "error",
	"timestamp": "2020-02-06T12:45:27.5903465Z"
}

No encontrado #

Cuando no se encuentran elementos de directorio que coincidan con el filtro proporcionado. 

HTTP/1.1 404 No encontrado
Fecha: Thu, 06 Feb 2020 12:46:58 GMT
Tipo de contenido: application/json; charset=utf-8
Contenido-Longitud: 95
{
	"error": 404,
	"message": "No encontrado",
	"status": "error",
	"marca de tiempo": "2020-02-06T12:46:58.7669535Z"
}