Obtenir des articles #

Obtient tous les éléments de répertoire correspondant au filtre fourni.

GET /v1.0/contactdirectories/{DIRECTORY_ID}/items ?filter={FILTRE}& fields={CHAMPS}

warning
N'oubliez pas de URL Encodez tous les paramètres transmis dans le ' filtre' paramètre.

note
Lors d'une recherche sur ' phoneX' champs, les numéros sont stockés dans E.164 format.

Exemple #

Cette requête interrogera tous les éléments dont le champ de téléphone contient +44XXXXXXXXXX

tip
Les recherches se font à l'aide d'un CONTAINS requête

Demander #

GET [https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items?filter%2B44XXXXXXXXXX=\&amp ; fields=phone1& fields=phone2& fields=phone3& 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
Autorisation : Porteur {TOKEN}

Réponse #

HTTP/1.1 200 OK
Type de contenu : application/json ; jeu de caractères=utf-8
Contenu-Longueur : xx
{
    « page_size » : 1,
	« données » : [ {
            « id » : « 00000000-0000-0000-0000-0000000123 »,
            « champs » : {
                « title » : « Monsieur »,
                « fullName » : « CRM2 »,
                « companyName » : « Société »,
                « jobTitle » : « Titre du poste »,
                « phone1 » : « +44XXXXXXXXXX »,
                « email » : « Adresse e-mail »,
                « field1 » : « field1 »,
                « field2 » : « field2 »,
                « crmId » : « 00000000-0000-0000-0000-00000000001 »
            }
        }
    ][{
            "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 » : « succès »,
	« timestamp » : « 2019-01-01T10:00:00.2890319Z »
}

Erreurs #

Non autorisée #

Lorsque le jeton n'est pas fourni, qu'il n'est pas valide ou qu'il a expiré

HTTP/1.1 401 Non autorisé

Mauvaise demande #

Lorsque le filtre ou les champs fournis ne sont pas au format correct

HTTP/1.1 400 Requête incorrecte
Date : Thu, 06 Feb 2020 12:45:27 GMT
Type de contenu : application/json ; jeu de caractères=utf-8
Contenu-Longueur : 149
{
	« error » : 400,
	« message » : « La valeur '<directory id>' n'est pas valide.",
	« status » : « erreur »,
	« timestamp » : « 2020-02-06T12:45:27.5903465Z »
}

Introuvable #

Lorsqu'aucun élément de répertoire ne correspond au filtre fourni.

HTTP/1.1 404 Introuvable
Date : Thu, 06 Feb 2020 12:46:58 GMT
Type de contenu : application/json ; jeu de caractères=utf-8
Contenu-Longueur : 95
{
	« error » : 404,
	« message » : « Introuvable »,
	« status » : « erreur »,
	« timestamp » : « 2020-02-06T12:46:58.7669535Z »
}