Objek

CompanyReference

Secara unik mengidentifikasi perusahaan.

Nama kolom Jenis data Deskripsi
companyId string Hanya output. ID perusahaan, yang ditetapkan oleh server.
vendor enum Samsung atau Google.

Perusahaan

Mewakili perusahaan.

Nama kolom Jenis data Deskripsi
companyReference object(CompanyReference) Objek referensi perusahaan.
companyName string Nama perusahaan. Misalnya XYZ Corp. Ditampilkan kepada karyawan perusahaan di portal pendaftaran zero-touch.
vendorParams map Kolom tambahan dalam pasangan nilai kunci yang ditentukan vendor.

Perangkat

Perangkat Android yang terdaftar untuk pendaftaran.

Nama kolom Jenis data Deskripsi
deviceId string Hanya output. ID perangkat, yang ditetapkan oleh server.
deviceIdentifier object(DeviceIdentifier) ID hardware yang mengidentifikasi perangkat yang diproduksi.
customer object(CompanyReference) ID perusahaan yang mengidentifikasi perusahaan tempat perangkat ditetapkan.
orderNumber string Nomor pesanan.
vendorParams map Kolom tambahan dalam pasangan nilai kunci yang ditentukan vendor.

DeviceIdentifier

Mengenkapsulasi ID hardware dan ID produk untuk mengidentifikasi perangkat produsen.

Perangkat Samsung memerlukan salah satu kolom berikut:

  • IMEI
  • serialNumber
  • meid

Semua kolom lainnya, seperti model, akan diabaikan.

Untuk semua perangkat Android lainnya:

  • Perangkat seluler memerlukan imei dan manufacturer.
  • Perangkat khusus Wi-Fi memerlukan serialNumber, manufacturer, dan model.
Nama kolom Jenis data Deskripsi
imei string Nomor IMEI perangkat. Divalidasi pada input.
serialNumber string Nomor seri produsen untuk perangkat. Nilai ini mungkin tidak unik di berbagai model perangkat.
meid string Nomor MEID perangkat.
manufacturer string Nama produsen perangkat. Mencocokkan nilai bawaan perangkat yang ditampilkan dari android.os.Build.MANUFACTURER. Nilai yang diizinkan tercantum di produsen.
model string Nama model perangkat. Mencocokkan nilai bawaan perangkat yang ditampilkan dari android.os.Build.MODEL. Nilai yang diizinkan tercantum di model.

Operasi

Resource ini berisi status panggilan API asinkron. Ada empat kemungkinan status:

  • IN_PROGRESS: Operasi sedang berlangsung.
  • COMPLETE: Semua perangkat berhasil diproses.
  • COMPLETE_WITH_ERRORS: Operasi telah diproses, tetapi terjadi beberapa error. Semua error tercantum dalam daftar deviceErrors.
  • FAILED: Operasi gagal dan tidak ada operationId yang ditampilkan.
Nama kolom Jenis data Deskripsi
operationId string ID operasi, yang diawali dengan samsung/ atau google/. Jika kosong,state adalah FAILED.
operationType enum(operationType) Jenis operasi: CLAIM_DEVICES atau UNCLAIM_DEVICES.
state enum(operationState) Status operasi: IN_PROGRESS, COMPLETE, COMPLETE_WITH_ERRORS, FAILED.
deviceErrors Daftar object(DeviceOperationError) Daftar error operasi perangkat.
vendorParams map Kolom tambahan dalam pasangan nilai kunci yang ditentukan vendor.

DeviceOperationError

Error khusus perangkat di Operation. Setiap resource berisi resource deviceId dan deviceIdentifier sebagai permintaan yang memulai operasi.

Nama kolom Jenis data Deskripsi
deviceId string Hanya output. ID perangkat, yang ditetapkan oleh server.
deviceIdentifier object(DeviceIdentifier) ID hardware yang mengidentifikasi perangkat yang diproduksi.
error object(Error) Kesalahan operasi perangkat.

CommonException

Pengecualian yang dapat ditampilkan oleh semua API sinkron.

Nama properti Nilai Deskripsi
error object(Error) Error operasi sinkron.

Error

Objek yang berisi detail tentang error.

Nama properti Nilai Deskripsi
code enum(ErrorCode) Kode error. Misalnya, INVALID_REQUESET atau PERMISSION_DENIED
message string Pesan error.
vendorMsg string Penjelasan mendetail tentang error dari vendor.
errorId string ID error internal.
vendorParams map Kolom tambahan dalam pasangan nilai kunci yang ditentukan vendor.

ErrorCode

Error umum.

Enum Deskripsi
INVALID_PARAM_DEFAULT Parameter input tidak valid tidak ditentukan. Lihat vendorMsg untuk mendapatkan detail selengkapnya.
INVALID_PAGE_TOKEN PageToken yang diberikan tidak valid.
INVALID_CUSTOMER_ID ID pelanggan yang diberikan tidak valid.
INVALID_DEVICE_IMEI IMEI tidak valid.
INVALID_DEVICE_MEID MEID tidak valid.
INVALID_DEVICE_SERIAL Nomor seri tidak valid.
INVALID_OPERATION_ID ID operasi yang disediakan tidak valid.
INVALID_RESELLER_ID resellerId yang diberikan tidak valid.
INVALID_MANUFACTURER Produsen yang diberikan tidak valid / tidak didukung.
INVALID_IDENTIFIER_SET Kumpulan ID yang diberikan tidak cukup untuk permintaan. Lihat DeviceIdentifier untuk informasi lebih lanjut tentang kumpulan ID yang diizinkan.
INVALID_MODEL Model yang diberikan tidak valid / tidak didukung.
INVALID_DEVICE_ID ID perangkat yang diberikan tidak valid.
INVALID_DEVICE Perangkat yang disediakan tidak ada. Ini adalah kode error khusus Samsung.
DUPLICATE_DEVICE Perangkat sebelumnya diklaim ke pelanggan yang sama. Tidak diperlukan tindakan korektif.
DEVICE_UPLOAD_COUNT_EXCEEDED Permintaan berisi lebih banyak perangkat yang melebihi batas (saat ini 100 ribu).
AUTHORIZATION_FAIL Anda tidak memiliki akses ke resource yang diberikan (misalnya perangkat, pelanggan), atau resource tidak ada. Lihat vendorMsg untuk mendapatkan detail selengkapnya.
INTERNAL_SERVER_ERROR Error server internal tidak ditentukan. Lihat vendorMsg untuk mendapatkan detail selengkapnya. Permintaan ini dapat dicoba lagi bergantung pada sifat error server.
NOT_IMPLEMENTED Metode permintaan tidak didukung oleh server.