Obtenir des articles #

Obtient tous les éléments d'annuaire correspondant au filtre fourni.

GET /v1.0/contactdirectories/{DIRECTORY_ID}/items ?filter={FILTER}& fields={FIELDS}

warning
N'oubliez pas de URL Codez tous les paramètres passés dans le ' filter' paramètre.

note
Lors de la recherche sur ' phoneX' , les nombres sont stockés dans E.164 format.

Exemple #

Cette demande interrogera tous les éléments avec un champ de téléphone contenant <c0>+44XXXXXXXXXXXXXXXXxx

tip
Les recherches sont effectuées à l'aide d'un CONTAINS requête

Demande #

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 ; charset=utf-8
Longueur du contenu : xx
{
    « page_size » : 1,
	« données » : [ {
            « id » : « 00000000-0000-0000-0000-0000000000123 »,
            « champs » : {
                « titre » : « Monsieur »,
                « fullName » : « CRM2 »,
                « companyName » : « Société »,
                « jobTitle » : « Titre du poste »,
                « phone1 » : « +44XXXXXXXXXXXX »,
                « e-mail » : « Adresse e-mail »,
                « champ1 » : « champ1 »,
                « field2 » : « field2 »,
                « crmId » : « 00000000-0000-0000-0000-0000000000001 »
            }
        }
    ][{
            "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"
            }
        }
    ],
	« statut » : « succès »,
	« horodatage » : « 2019-01-01T10:00:00.2890319Z »
}

Erreurs #

Non autorisé #

Lorsque le jeton n'est pas fourni, non valide ou expiré

HTTP/1.1 401 Non autorisé

Mauvaise demande #

Lorsque le ou les champs de filtre fournis ne sont pas dans le bon format

HTTP/1.1 400 Mauvaise demande
Date : Jeu, 06 Février 2020 12:45:27 GMT
Type de contenu : application/json ; charset=utf-8
Durée du contenu : 149
{
	« erreur » : 400,
	« message » : « La valeur '<directory id>' n'est pas valide.",
	« statut » : « erreur »,
	« horodatage » : « 2020-02-06T12:45:27.5903465Z »
}

Introuvable #

Lorsqu'il n'y a pas d'éléments de répertoire trouvés pour correspondre au filtre fourni.

HTTP/1.1 404 Introuvable
Date : Jeu, 06 Février 2020 12:46:58 GMT
Type de contenu : application/json ; charset=utf-8
Durée du contenu : 95
{
	« erreur » : 404,
	« message » : « Introuvable »,
	« statut » : « erreur »,
	« horodatage » : « 2020-02-06T12:46:58.7669535Z »
}