Dapatkan Item

Dapatkan Item #

Mendapatkan item direktori apa pun yang cocok dengan filter yang disediakan.

GET /v1.0/contactdirectories/{DIRECTORY_ID}/items?filter={FILTER}& bidang={BIDANG}

Hand Left warning
Ingat untuk URL Enkodekan parameter apa pun yang diteruskan di ' filter' parameter.
Document note
Saat mencari ' teleponX' bidang, angka-angka disimpan di E.164 format.

Contoh #

Permintaan ini akan mengkueri semua item dengan bidang telepon yang berisi +44XXXXXXXXXX

Color Wand tip
Pencarian dilakukan menggunakan CONTAINS kueri

Minta #

GET [https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items?filter%2B44XXXXXXXXXX=& bidang=phone1& bidang=phone2& bidang=phone3& bidang=telepon4](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
Otorisasi: Pembawa {TOKEN}

Jawaban #

HTTP/1.1 200 OK
Jenis Konten: application/json; set karakter = utf-8
Panjang Konten: xx
{
    "page_size": 1,
	"data": [ {
            "id": "00000000-0000-0000-0000-000000000123",
            "bidang": {
                "title": "Tuan",
                "nama penuh": "CRM2",
                "companyName": "Perusahaan",
                "jobTitle": "Jabatan",
                "telepon1": "+44XXXXXXXXXX",
                "email": "Alamat Email",
                "field1": "field1",
                "field2": "bidang2",
                "crmId": "00000000-0000-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"
            }
        }
    ],
	"status": "berhasil",
	"stempel waktu": "2019-01-01T10:00:00.2890319Z"
}

Kesalahan #

Sah #

Ketika token tidak diberikan, tidak valid atau kedaluwarsa

HTTP/1.1 401 Tidak Sah

Permintaan Buruk #

Ketika filter atau bidang yang disediakan tidak dalam format yang benar

HTTP/1.1 400 Permintaan Buruk
Tanggal: Thu, 06 Feb 2020 12:45:27 GMT
Jenis Konten: application/json; set karakter = utf-8
Panjang Konten: 149
{
	"kesalahan": 400,
	"message": "Nilai '<directory id>' tidak valid.",
	"status": "kesalahan",
	"stempel waktu": "2020-02-06T12:45:27.5903465Z"
}

Tidak ditemukan #

Ketika tidak ada item direktori yang ditemukan untuk cocok dengan filter yang disediakan.

HTTP/1.1 404 Tidak Ditemukan
Tanggal: Thu, 06 Feb 2020 12:46:58 GMT
Jenis Konten: application/json; set karakter = utf-8
Panjang-Konten: 95
{
	"kesalahan": 404,
	"message": "Tidak Ditemukan",
	"status": "kesalahan",
	"stempel waktu": "2020-02-06T12:46:58.7669535Z"
}