Ikhtisar Item on ~.UcClient.~ Unified Communications

Dapatkan Item

Mon, 01 Jan 0001 00:00:00 +0000

Dapatkan Item #

Mendapatkan item direktori tertentu.

GET /v1.0/contactdirectories/{DIRECTORY_ID}/items/{DIRECTORY_ITEM_ID}

Contoh #

Permintaan ini akan mendapatkan item tertentu dari direktori kami idnya.

Minta #

GET <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123> 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

Dapatkan Item

Mon, 01 Jan 0001 00:00:00 +0000

Dapatkan Item #

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

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

warning
Ingat untuk URL Enkodekan parameter apa pun yang diteruskan di ' filter' parameter.

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

Buat Item

Mon, 01 Jan 0001 00:00:00 +0000

Buat Item #

Membuat item direktori baru di direktori yang disediakan.

POST /v1.0/contactdirectories/{DIRECTORY_ID}/items

Contoh #

Permintaan ini akan membuat item direktori baru.

Minta #

POST <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items> HTTP/1.1
Jenis Konten: aplikasi/json
Menerima biaya: benar
Otorisasi: Pembawa {TOKEN}
Koneksi: tetap hidup
{
	"bidang": {
        "judul": "Tuan",
        "fullName": "CRM3a",
        "companyName": "Perusahaan",
        "jobTitle": "Judul Pekerjaan",
        "telepon1": "+44XXXXXXXXXX",
        "email": "Alamat Email",
        "bidang1": "bidang1",
        "bidang2": "bidang2",
        "crmId": "00000000-0000-0000-00000-000000000001"
    }
}

Jawaban #

HTTP/1.1 201 Dibuat
Jenis Konten: aplikasi/json; Charset = UTF-8
Durasi Konten: xx
Lokasi: <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items>
{
	"data": {
        "id": "00000000-0000-0000-0000-00000000000123",
        "bidang": {
            "judul": "Tuan",
            "fullName": "CRM3a",
            "companyName": "Perusahaan",
            "jobTitle": "Judul Pekerjaan",
            "telepon1": "+44XXXXXXXXXX",
            "email": "Alamat Email",
            "bidang1": "bidang1",
            "bidang2": "bidang2",
            "crmId": "00000000-0000-0000-00000-000000000001"
        }
    },
	"status": "sukses",
	"stempel waktu": "2019-11-29T16:03:23.9251680Z"
}

Kesalahan #

Sah #

Ketika token tidak diberikan, tidak valid atau kedaluwarsa

HTTP/1.1 401 Tidak Sah

Ganti Item

Mon, 01 Jan 0001 00:00:00 +0000

Ganti Item #

Mengganti dan item direktori yang ada.

PUT /v1.0/contactdirectories/{DIRECTORY_ID}/items/{DIRECTORY_ITEM_ID}

Contoh #

Permintaan ini akan memperbarui item direktori yang ada.

Minta #

PUT <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123> HTTP/1.1
Jenis Konten: aplikasi/json
Menerima biaya: benar
Otorisasi: Pembawa {TOKEN}
Koneksi: tetap hidup
{
    "bidang": {
        "judul": "Tuan",
        "fullName": "CRM3a",
        "companyName": "Perusahaan",
        "jobTitle": "Judul Pekerjaan",
        "telepon1": "+44XXXXXXXXXX",
        "email": "Alamat Email",
        "bidang1": "bidang1",
        "bidang2": "bidang2",
        "crmId": "00000000-0000-0000-00000-000000000001"
    }
}

Jawaban #

HTTP/1.1 201 Dibuat
Jenis Konten: aplikasi/json; Charset = UTF-8
Durasi Konten: xx
Lokasi: <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123>
{
	"data": {
        "id": "00000000-0000-0000-0000-00000000000123",
        "bidang": {
            "judul": "Tuan",
            "fullName": "CRM3a",
            "companyName": "Perusahaan",
            "jobTitle": "Judul Pekerjaan",
            "telepon1": "+44XXXXXXXXXX",
            "email": "Alamat Email",
            "bidang1": "bidang1",
            "bidang2": "bidang2",
            "crmId": "00000000-0000-0000-00000-000000000001"
        }
    },
	"status": "sukses",
	"stempel waktu": "2019-11-29T16:03:23.9251680Z"
}

Kesalahan #

Sah #

Ketika token tidak diberikan, tidak valid atau kedaluwarsa

HTTP/1.1 401 Tidak Sah

Item Tambalan

Mon, 01 Jan 0001 00:00:00 +0000

Item Tambalan #

Memperbarui kumpulan properti tertentu dari item direktori. Ini menggunakan JSON Format tambalan untuk setiap perubahan.

PATCH /v1.0/contactdirectories/{DIRECTORY_ID}/items/{DIRECTORY_ITEM_ID}

Contoh #

Permintaan ini akan menambahkan bidang telepon baru ke item direktori yang ada.

Minta #

PATCH <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123> HTTP/1.1
Jenis Konten: aplikasi/json
Menerima biaya: benar
Otorisasi: Pembawa {TOKEN}
Koneksi: tetap hidup
{
    "jalur": "/bidang/telepon2",
    "op": "tambahkan",
    "value": "+44YYYYYYYYYYYYYYYYYY"
}

Jawaban #

HTTP/1.1 201 Dibuat
Jenis Konten: aplikasi/json; Charset = UTF-8
Durasi Konten: xx
Lokasi: <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123>
{
	"data": {
        "id": "00000000-0000-0000-0000-00000000000123",
        "bidang": {
            "judul": "Tuan",
            "fullName": "CRM3a",
            "companyName": "Perusahaan",
            "jobTitle": "Judul Pekerjaan",
            "telepon1": "+44XXXXXXXXXX",
            "telepon2": "+44YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY
            "email": "Alamat Email",
            "bidang1": "bidang1",
            "bidang2": "bidang2",
            "crmId": "00000000-0000-0000-00000-000000000001"
        }
    },
	"status": "sukses",
	"stempel waktu": "2019-11-29T16:03:23.9251680Z"
}

Kesalahan #

Sah #

Ketika token tidak diberikan, tidak valid atau kedaluwarsa

HTTP/1.1 401 Tidak Sah

Hapus Item

Mon, 01 Jan 0001 00:00:00 +0000

Hapus Item #

Menghapus item yang ada dari direktori.

Minta #

DELETE /v1.0/contactdirectories/{DIRECTORY_ID}/items/{DIRECTORY_ITEM_ID}

Contoh #

Permintaan ini akan menghapus item tertentu dalam direktori.

Minta #

DELETE <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123> HTTP/1.1
Otorisasi: Pembawa {TOKEN}

Jawaban #

HTTP/1.1 200 OK
Jenis Konten: application/json; set karakter = utf-8
Panjang Konten: xx
{ 
	"data": {
        "id": "00000000-0000-0000-0000-000000000123",
        "bidang": {
            "title": "Tuan",
            "nama penuh": "CRM3a",
            "companyName": "Perusahaan",
            "jobTitle": "Jabatan",
            "telepon1": "+44XXXXXXXXXX",
            "email": "Alamat Email",
            "field1": "field1",
            "field2": "bidang2",
            "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