Gegenstände erhalten

Gegenstände erhalten #

Erhält alle Verzeichniseinträge, die mit dem bereitgestellten Filter übereinstimmen.

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

Hand Left warning
Denken Sie daran zu URL Kodieren Sie alle Parameter, die im Parameter 'filter' übergeben werden.
Document note
Bei der Suche in 'phoneX' Feldern werden die Zahlen im Format E.164 gespeichert.

Beispiel #

Diese Anfrage fragt alle Einträge mit einem Telefonfeld ab, das <c0>+44XXXXXXXXXX</c0 enthält>

Color Wand tip
Suchen erfolgen mit einer Abfrage CONTAINS

Anfrage # 

GET <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
Autorisierung: Inhaber {TOKEN}

Reaktion # 

HTTP/1.1 200 OK
Inhaltstyp: application/json; charset=utf-8
Inhalt-Länge: xx
{
    "page_size": 1,
	"data": [{
            "id": "00000000-0000-0000-00000-00000000123",
            "Felder": {
                "Titel": "Herr",
                "fullName": "CRM2",
                "Firmenname": "Unternehmen",
                "JobTitle": "Jobtitel",
                "phone1": "+44XXXXXXXXXX",
                "E-Mail": "E-Mail-Adresse",
                "Feld1": "Feld1",
                "Feld2": "Feld2",
                "crmId": "00000000-0000-0000-000000-0000000001"
            }
        }
    ][{
            "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": "Erfolg",
	"Zeitstempel": "2019-01-01T10:00:00.2890319Z"
}

Fehler #

Unautorisiert #

Wenn der Token nicht bereitgestellt wird, ungültig oder abgelaufen ist 

HTTP/1.1 401 Unautorisiert

Schlechte Anfrage #

Wenn der bereitgestellte Filter oder die Felder nicht im richtigen Format sind 

HTTP/1.1 400 Bad Request
Datum: Do, 06. Feb 2020 12:45:27 GMT
Inhaltstyp: application/json; charset=utf-8
Inhalt-Länge: 149
{
	"Fehler": 400,
	"Nachricht": "Der Wert '<directory id>'ist nicht gültig.",
	"status": "fehler",
	"Zeitstempel": "2020-02-06T12:45:27.5903465Z"
}

Nicht gefunden #

Wenn keine Verzeichniseinträge gefunden werden, die mit dem bereitgestellten Filter übereinstimmen. 

HTTP/1.1 404 Nicht gefunden
Datum: Do, 06. Feb 2020 12:46:58 GMT
Inhaltstyp: application/json; charset=utf-8
Inhalt-Länge: 95
{
	"error": 404,
	"Nachricht": "Nicht gefunden",
	"status": "fehler",
	"Zeitstempel": "2020-02-06T12:46:58.7669535Z"
}