احصل على العناصر

احصل على العناصر #

تحصل على أي عناصر في الدليل تطابق المرشح المرفق.

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

Hand Left warning
تذكر URL ترميز أي معلمات يتم تمريرها في معامل 'filter'.
Document note
عند البحث في حقول 'phoneX'، تخزن الأرقام بصيغة E.164.

مثال #

سيقوم هذا الطلب بالاستعلام عن جميع العناصر التي تحتوي على حقل هاتف يحتوي على +44XXXXXXXXXXXX

Color Wand tip
يتم البحث باستخدام استعلام CONTAINS

طلب #

 
احصل على <https://api.eu.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
التفويض: حامل {TOKEN}

الرد #

 
HTTP/1.1 200 OK
نوع المحتوى: application/json; charset=utf-8
مدة المحتوى: xx
{ 
    "page_size": 1, 
	"data": [{ 
            "المعرف": "00000000-0000-0000-0000-00000-000000000123", 
            "الحقول": { 
                "العنوان": "السيد", 
                "الاسم الكامل": "CRM2", 
                "اسم الشركة": "الشركة", 
                "مسمى الوظيفة": "مسمى الوظيفة", 
                "phone1": "+44XXXXXXXXXXXXX", 
                "البريد الإلكتروني": "عنوان البريد الإلكتروني", 
                "الحقل1": "الحقل1", 
                "الحقل2": "الحقل2", 
                "crmId": "00000000-00000-0000-0000-000000000001" 
            }
        }
    ][{
            "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"
            }
        }
    ]، 
	"المكانة": "نجاح", 
	"الطابع الزمني": "2019-01-01T10:00:00.2890319Z" 
}

الأخطاء #

غير مصرح به #

عندما لا يتم توفير الرمز أو غير صالح أو منتهية الصلاحية

 
HTTP/1.1 401 غير مصرح به

طلب سيء #

عندما لا تكون المرشح أو الحقول المقدمة بالصيغة الصحيحة

 
HTTP/1.1 طلب سيء 400
التاريخ: الخميس، 06 فبراير 2020 12:45:27 بتوقيت غرينتش
نوع المحتوى: application/json; charset=utf-8
طول المحتوى: 149
{ 
	"خطأ": 400, 
	"رسالة": "القيمة '<directory id>' غير صحيح.", 
	"الحالة": "خطأ", 
	"الطابع الزمني": "2020-02-06T12:45:27.5903465Z" 
}

لم يعثر عليه #

عندما لا توجد عناصر دليل تتطابق مع المرشح المرفق.

 
HTTP/1.1 404 غير موجود
التاريخ: الخميس، 06 فبراير 2020 12:46:58 بتوقيت غرينتش
نوع المحتوى: application/json; charset=utf-8
طول المحتوى: 95
{ 
	"الخطأ": 404, 
	"رسالة": "لم يتم العثور عليه", 
	"الحالة": "خطأ", 
	"الطابع الزمني": "2020-02-06T12:46:58.7669535Z" 
}