Pelanggan Patch #

Memperbarui serangkaian properti tertentu dari Pelanggan. Ini menggunakan JSON Format tambalan untuk setiap perubahan.

PATCH /v1.0/pelanggan/{CUSTOMER_TENANT_ID}

Contoh #

Permintaan ini akan memperbarui Kunci Api dari PBX koneksi dan mengaktifkannya.

Minta #

PATCH <https://api.na.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/> HTTP/1.1
Jenis Konten: aplikasi/json
Menerima biaya: benar
Otorisasi: Pembawa {TOKEN}
Koneksi: tetap hidup
[ {
		"op": "mengganti",
		"jalur": "/enabled",
		"value": false
	}, {
		"op": "mengganti",
		"jalur": "/pbxConnectionProfile/apiKey",
		"value": "newapikey"
	}
][{
		"op": "replace",
		"path": "/enabled",
		"value": false
	}, {
		"op": "replace",
		"path": "/pbxConnectionProfile/apiKey",
		"value": "newapikey"
	}
]

Jawaban #

HTTP/1.1 200 OK
Jenis Konten: aplikasi/json; Charset = UTF-8
Durasi Konten: xx
Konteks Permintaan: appId=cid-v1:d24f4c80-0a0a-432e-85aa-a6f91f13a038
{
	"status": "sukses",
	"stempel waktu": "2019-11-29T15:16:54.2586208Z"
}

Kesalahan #

Sah #

Ketika token tidak disediakan, tidak valid atau kedaluwarsa

HTTP/1.1 401 Tidak sah

Permintaan Buruk (1) #

Ketika id penyewa yang diberikan tidak dalam format yang benar

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

Permintaan Buruk (2) #

Saat mencoba menambal properti yang tidak valid.

HTTP/1.1 400 Permintaan Buruk
Tanggal: Thu, 06 Feb 2020 12:45:27 GMT
Jenis Konten: aplikasi/json; Charset = UTF-8
Panjang Konten: 149
{
	"kesalahan": 400,
	"message": "Lokasi target yang ditentukan oleh segmen jalur '<invalid property>' tidak ditemukan.",
	"status": "kesalahan",
	"stempel waktu": "2020-02-06T12:45:27.5903465Z"
}

Tidak Ditemukan #

Jika tidak ada Pelanggan yang memiliki id penyewa yang cocok

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