أغراض

CompanyReference

يعرّف عن الشركة الشركة بشكل فريد.

اسم الحقل نوع البيانات الوصف
companyId string النتائج فقط. رقم تعريف الشركة، الذي يعينه الخادم.
vendor enum Samsung أو Google

الشركة

يمثل شركة.

اسم الحقل نوع البيانات الوصف
companyReference object(CompanyReference) عنصر مرجعي للشركة
companyName string اسم الشركة. على سبيل المثال، XYZ Corp. يتم عرضه لموظفي الشركة في بوابة "إعداد الأجهزة الجوّالة للمؤسّسات دفعةً واحدة".
vendorParams map حقول إضافية في أزواج المفتاح/القيمة التي يحدّدها المورّد

الجهاز

جهاز Android مسجَّل للتسجيل

اسم الحقل نوع البيانات الوصف
deviceId string النتائج فقط. رقم تعريف الجهاز الذي حدّده الخادم.
deviceIdentifier object(DeviceIdentifier) أرقام تعريف الأجهزة التي تحدد هوية جهاز تم تصنيعه.
customer object(CompanyReference) أرقام تعريف الشركة التي تحدد الشركة التي تم تعيين الأجهزة لها.
orderNumber string رقم الطلب.
vendorParams map حقول إضافية في أزواج المفتاح/القيمة التي يحدّدها المورّد

معرّف الجهاز

يتضمّن هذا الحقل معرّفات الأجهزة والمنتجات لتحديد جهاز الشركة المصنّعة.

تتطلّب أجهزة Samsung أحد الحقول التالية:

  • IMEI
  • serialNumber
  • meid

ويتم تجاهل جميع الحقول الأخرى، مثل model.

لجميع أجهزة Android الأخرى:

  • تتطلّب الأجهزة الجوّالة استخدام imei وmanufacturer.
  • يجب توفّر serialNumber وmanufacturer وmodel للأجهزة التي تتيح الاتصال بشبكة Wi-Fi فقط.
اسم الحقل نوع البيانات الوصف
imei string رقم IMEI للجهاز تم التحقّق من صحة البيانات عند الإدخال.
serialNumber string الرقم التسلسلي للشركة المصنّعة للجهاز قد لا تكون هذه القيمة فريدة على مستوى طُرز الأجهزة المختلفة.
meid string رقم MEID للجهاز.
manufacturer string اسم الشركة المصنّعة للجهاز يطابق القيمة المضمنة في الجهاز التي يتم عرضها من android.os.Build.MANUFACTURER. يتم إدراج القيم المسموح بها في بيانات الشركة المصنّعة.
model string اسم طراز الجهاز يطابق القيمة المضمنة في الجهاز التي يتم عرضها من android.os.Build.MODEL. يتم إدراج القيم المسموح بها في models.

العملية

يحتوي هذا المورد على حالة طلب البيانات من واجهة برمجة التطبيقات غير المتزامن. هناك أربعة الحالات المحتملة:

  • IN_PROGRESS: العملية قيد التقدم.
  • COMPLETE: تمت معالجة جميع الأجهزة بنجاح.
  • COMPLETE_WITH_ERRORS: تمت معالجة العملية، ولكن حدثت بعض الأخطاء. تم إدراج جميع الأخطاء في قائمة "deviceErrors".
  • FAILED: تعذّر إتمام العملية ولم يتم عرض أي operationId.
اسم الحقل نوع البيانات الوصف
operationId string معرّف العملية، الذي يبدأ بـ samsung/ أو google/. إذا كانت فارغة، تكون قيمة state FAILED.
operationType enum(operationType) نوع العملية: CLAIM_DEVICES أو UNCLAIM_DEVICES.
state enum(operationState) حالة العملية: IN_PROGRESS، COMPLETE، COMPLETE_WITH_ERRORS، FAILED.
deviceErrors قائمة object(DeviceOperationError) قائمة أخطاء تشغيل الجهاز
vendorParams map حقول إضافية في أزواج المفتاح/القيمة التي يحدّدها المورّد

DeviceOperationError

حدث خطأ خاص بجهاز في Operation. يحتوي كل مورد على نفس deviceId وdeviceIdentifier كالطلب الذي بدأ العملية.

اسم الحقل نوع البيانات الوصف
deviceId string النتائج فقط. رقم تعريف الجهاز الذي حدّده الخادم.
deviceIdentifier object(DeviceIdentifier) أرقام تعريف الأجهزة التي تحدد هوية جهاز تم تصنيعه.
error object(Error) حدث خطأ أثناء تشغيل الجهاز.

CommonException

يشير ذلك المصطلح إلى استثناء يمكن طرحه من خلال جميع واجهات برمجة التطبيقات المتزامنة.

اسم الموقع القيمة الوصف
error object(Error) حدث خطأ في التشغيل المتزامن.

خطأ

كائن يحتوي على تفاصيل عن خطأ معيّن

اسم الموقع القيمة الوصف
code enum(ErrorCode) رمز الخطأ. على سبيل المثال، INVALID_REQUESET أو PERMISSION_DENIED
message string رسالة الخطأ.
vendorMsg string شرح تفصيلي للخطأ من المورِّد.
errorId string معرِّف الخطأ الداخلي
vendorParams map حقول إضافية في أزواج المفتاح/القيمة التي يحدّدها المورّد

ErrorCode

الأخطاء الشائعة

Enum الوصف
INVALID_PARAM_DEFAULT مَعلمة إدخال غير صالحة غير محدّدة. انظر إلى SellerMsg للحصول على مزيد من التفاصيل.
INVALID_PAGE_TOKEN رمز pageToken الذي تم تقديمه غير صالح.
INVALID_CUSTOMER_ID رقم تعريف العميل الذي تم تقديمه غير صالح.
INVALID_DEVICE_IMEI رقم IMEI هذا غير صالح.
INVALID_DEVICE_MEID MEID غير صالح.
INVALID_DEVICE_SERIAL الرقم التسلسلي غير صالح.
INVALID_OPERATION_ID معرّف العملية الذي تم تقديمه غير صالح.
INVALID_RESELLER_ID رقم تعريف المورّد الذي تم تقديمه غير صالح.
INVALID_MANUFACTURER الشركة المصنّعة التي قدّمتها غير صالحة أو غير متوافقة.
INVALID_IDENTIFIER_SET مجموعة المعرّفات المقدَّمة غير كافية للطلب. يمكنك الانتقال إلى DeviceIdentifier للحصول على مزيد من المعلومات عن مجموعات المعرّفات المسموح بها.
INVALID_MODEL النموذج الذي تمّ تقديمه غير صالح أو غير متوافق.
INVALID_DEVICE_ID رقم تعريف الجهاز الذي تم تقديمه غير صالح.
INVALID_DEVICE الجهاز الذي تم تقديمه غير متوفّر. هذا رمز خطأ خاص بـ Samsung.
DUPLICATE_DEVICE سبق أن تمت المطالبة بملكية الجهاز للعميل نفسه. وليس عليك اتّخاذ أي إجراء تصحيحي.
DEVICE_UPLOAD_COUNT_EXCEEDED يحتوي الطلب على مزيد من الأجهزة التي يصل عددها إلى الحد الأقصى (حاليًا 100 ألف جهاز).
AUTHORIZATION_FAIL لا تتوفر لك إمكانية الوصول إلى مورد معين (جهاز أو عميل مثلاً) أو المورد غير موجود. لمزيد من التفاصيل، يُرجى الاطّلاع على vendorMsg.
INTERNAL_SERVER_ERROR حدث خطأ غير محدَّد في الخادم الداخلي. انظر إلى sellerMsg للحصول على مزيد من التفاصيل. ويمكن إعادة محاولة تنفيذ هذه الطلبات اعتمادًا على طبيعة الخطأ في الخادم.
NOT_IMPLEMENTED طريقة الطلب غير متوافقة مع الخادم.