اشیاء

مرجع شرکت

منحصر به فرد یک شرکت را شناسایی می کند.

نام زمینه	نوع داده	شرح
companyId	string	فقط خروجی شناسه شرکت که توسط سرور اختصاص داده شده است.
vendor	enum	Samsung یا Google

شرکت

نماینده یک شرکت است.

نام زمینه	نوع داده	شرح
companyReference	object( CompanyReference )	شی مرجع شرکت.
companyName	string	نام شرکت. به عنوان مثال XYZ Corp. در پورتال ثبت نام بدون لمس برای کارکنان شرکت نمایش داده می شود.
vendorParams	map	فیلدهای اضافی در جفت های کلید-مقدار مشخص شده توسط فروشنده.

دستگاه

یک دستگاه اندرویدی که برای ثبت نام ثبت شده است.

نام زمینه	نوع داده	شرح
deviceId	string	فقط خروجی شناسه دستگاه که توسط سرور اختصاص داده شده است.
deviceIdentifier	object( DeviceIdentifier )	شناسه های سخت افزاری که دستگاه تولید شده را شناسایی می کنند.
customer	object( CompanyReference )	شناسه های شرکت که مشخص می کند دستگاه ها به کدام شرکت اختصاص داده شده است.
orderNumber	string	شماره سفارش
vendorParams	map	فیلدهای اضافی در جفت های کلید-مقدار مشخص شده توسط فروشنده.

DeviceIdentifier

شناسه‌های سخت‌افزار و محصول را برای شناسایی دستگاه سازنده محصور می‌کند.

دستگاه های سامسونگ به یکی از فیلدهای زیر نیاز دارند:

• IMEI
• serialNumber
• meid

همه فیلدهای دیگر، مانند model ، نادیده گرفته می شوند.

برای همه دستگاه های اندرویدی دیگر:

• دستگاه های تلفن همراه به imei و manufacturer نیاز دارند.
• دستگاه‌های دارای WiFi فقط serialNumber ، manufacturer و model نیاز دارند.

نام زمینه	نوع داده	شرح
imei	string	شماره IMEI دستگاه در ورودی تایید شد.
serialNumber	string	شماره سریال سازنده دستگاه. این مقدار ممکن است در مدل های مختلف دستگاه منحصر به فرد نباشد.
meid	string	شماره MEID دستگاه
manufacturer	string	نام سازنده دستگاه با مقدار داخلی دستگاه برگردانده شده از android.os.Build.MANUFACTURER مطابقت دارد. مقادیر مجاز در تولید کنندگان ذکر شده است.
model	string	نام مدل دستگاه با مقدار داخلی دستگاه برگردانده شده از android.os.Build.MODEL مطابقت دارد. مقادیر مجاز در مدل ها ذکر شده است.

عمل

این منبع شامل وضعیت تماس API ناهمزمان است. چهار وضعیت ممکن وجود دارد:

• 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	فیلدهای اضافی در جفت های کلید-مقدار مشخص شده توسط فروشنده.

خطای عملکرد دستگاه

یک خطای خاص دستگاه در یک Operation . هر منبع حاوی همان deviceId و deviceIdentifier به عنوان درخواستی است که عملیات را آغاز کرده است.

نام زمینه	نوع داده	شرح
deviceId	string	فقط خروجی شناسه دستگاه که توسط سرور اختصاص داده شده است.
deviceIdentifier	object( DeviceIdentifier )	شناسه های سخت افزاری که دستگاه تولید شده را شناسایی می کنند.
error	object( Error )	خطای عملکرد دستگاه

CommonException

استثنایی که می تواند توسط همه APIهای همزمان ایجاد شود.

نام ملک	ارزش	شرح
error	object( Error )	خطای عملیات همزمان.

خطا

یک شی حاوی جزئیات مربوط به یک خطا.

نام ملک	ارزش	شرح
code	enum( ErrorCode )	کد خطا برای مثال، INVALID_REQUESET یا PERMISSION_DENIED
message	string	پیام خطا.
vendorMsg	string	توضیح دقیق خطا از طرف فروشنده.
errorId	string	شناسه خطای داخلی
vendorParams	map	فیلدهای اضافی در جفت های کلید-مقدار مشخص شده توسط فروشنده.

کد خطا

خطاهای رایج

Enum	شرح
INVALID_PARAM_DEFAULT	پارامتر ورودی نامعتبر. برای دریافت جزئیات بیشتر به vendorMsg نگاه کنید.
INVALID_PAGE_TOKEN	PageToken ارائه شده نامعتبر است.
INVALID_CUSTOMER_ID	شناسه مشتری ارائه شده نامعتبر است.
INVALID_DEVICE_IMEI	IMEI نامعتبر است.
INVALID_DEVICE_MEID	MEID نامعتبر است.
INVALID_DEVICE_SERIAL	شماره سریال اشتباه.
INVALID_OPERATION_ID	OperationId ارائه شده نامعتبر است.
INVALID_RESELLER_ID	شناسه Reseller ارائه شده نامعتبر است.
INVALID_MANUFACTURER	سازنده ارائه شده نامعتبر / پشتیبانی نمی شود.
INVALID_IDENTIFIER_SET	مجموعه ای از شناسه های ارائه شده برای درخواست کافی نیست. برای اطلاعات بیشتر در مورد مجموعه‌های شناسه مجاز، به DeviceIdentifier مراجعه کنید.
INVALID_MODEL	مدل ارائه شده نامعتبر / پشتیبانی نمی شود.
INVALID_DEVICE_ID	شناسه دستگاه ارائه شده نامعتبر است.
INVALID_DEVICE	دستگاه ارائه شده وجود ندارد. این یک کد خطای خاص سامسونگ است.
DUPLICATE_DEVICE	این دستگاه قبلاً به همان مشتری ادعا شده بود. هیچ اقدام اصلاحی لازم نیست.
DEVICE_UPLOAD_COUNT_EXCEEDED	این درخواست شامل دستگاه‌های بیشتری است که حد مجاز (در حال حاضر 100 هزار نفر) است.
AUTHORIZATION_FAIL	شما به یک منبع معین (مثلاً دستگاه، مشتری) دسترسی ندارید یا این منبع وجود ندارد. برای دریافت جزئیات بیشتر به vendorMsg نگاه کنید.
INTERNAL_SERVER_ERROR	خطای سرور داخلی نامشخص. برای دریافت جزئیات بیشتر به vendorMsg نگاه کنید. بسته به ماهیت خطای سرور می توان این درخواست ها را دوباره امتحان کرد.
NOT_IMPLEMENTED	روش درخواست توسط سرور پشتیبانی نمی شود.

،

مرجع شرکت

منحصر به فرد یک شرکت را شناسایی می کند.

نام زمینه	نوع داده	شرح
companyId	string	فقط خروجی شناسه شرکت، اختصاص داده شده توسط سرور.
vendor	enum	Samsung یا Google

شرکت

نماینده یک شرکت است.

نام زمینه	نوع داده	شرح
companyReference	object( CompanyReference )	شی مرجع شرکت.
companyName	string	نام شرکت. به عنوان مثال XYZ Corp. در پورتال ثبت نام بدون لمس برای کارکنان شرکت نمایش داده می شود.
vendorParams	map	فیلدهای اضافی در جفت های کلید-مقدار مشخص شده توسط فروشنده.

دستگاه

یک دستگاه اندرویدی که برای ثبت نام ثبت شده است.

نام زمینه	نوع داده	شرح
deviceId	string	فقط خروجی شناسه دستگاه که توسط سرور اختصاص داده شده است.
deviceIdentifier	object( DeviceIdentifier )	شناسه های سخت افزاری که دستگاه تولید شده را شناسایی می کنند.
customer	object( CompanyReference )	شناسه های شرکت که مشخص می کند دستگاه ها به کدام شرکت اختصاص داده شده است.
orderNumber	string	شماره سفارش
vendorParams	map	فیلدهای اضافی در جفت های کلید-مقدار مشخص شده توسط فروشنده.

DeviceIdentifier

شناسه‌های سخت‌افزار و محصول را برای شناسایی دستگاه سازنده محصور می‌کند.

دستگاه های سامسونگ به یکی از فیلدهای زیر نیاز دارند:

• IMEI
• serialNumber
• meid

همه فیلدهای دیگر، مانند model ، نادیده گرفته می شوند.

برای همه دستگاه های اندرویدی دیگر:

• دستگاه های تلفن همراه به imei و manufacturer نیاز دارند.
• دستگاه‌های دارای WiFi فقط serialNumber ، manufacturer و model نیاز دارند.

نام زمینه	نوع داده	شرح
imei	string	شماره IMEI دستگاه در ورودی تایید شد.
serialNumber	string	شماره سریال سازنده دستگاه. این مقدار ممکن است در مدل های مختلف دستگاه منحصر به فرد نباشد.
meid	string	شماره MEID دستگاه
manufacturer	string	نام سازنده دستگاه با مقدار داخلی دستگاه برگردانده شده از android.os.Build.MANUFACTURER مطابقت دارد. مقادیر مجاز در تولید کنندگان ذکر شده است.
model	string	نام مدل دستگاه با مقدار داخلی دستگاه برگردانده شده از android.os.Build.MODEL مطابقت دارد. مقادیر مجاز در مدل ها ذکر شده است.

عمل

این منبع شامل وضعیت تماس API ناهمزمان است. چهار وضعیت ممکن وجود دارد:

• 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	فیلدهای اضافی در جفت های کلید-مقدار مشخص شده توسط فروشنده.

خطای عملکرد دستگاه

یک خطای خاص دستگاه در یک Operation . هر منبع حاوی همان deviceId و deviceIdentifier به عنوان درخواستی است که عملیات را آغاز کرده است.

نام زمینه	نوع داده	شرح
deviceId	string	فقط خروجی شناسه دستگاه که توسط سرور اختصاص داده شده است.
deviceIdentifier	object( DeviceIdentifier )	شناسه های سخت افزاری که دستگاه تولید شده را شناسایی می کنند.
error	object( Error )	خطای عملکرد دستگاه

CommonException

استثنایی که می تواند توسط همه APIهای همزمان ایجاد شود.

نام ملک	ارزش	شرح
error	object( Error )	خطای عملیات همزمان.

خطا

یک شی حاوی جزئیات مربوط به یک خطا.

نام ملک	ارزش	شرح
code	enum( ErrorCode )	کد خطا برای مثال، INVALID_REQUESET یا PERMISSION_DENIED
message	string	پیام خطا.
vendorMsg	string	توضیح دقیق خطا از طرف فروشنده.
errorId	string	شناسه خطای داخلی
vendorParams	map	فیلدهای اضافی در جفت های کلید-مقدار مشخص شده توسط فروشنده.

کد خطا

خطاهای رایج

Enum	شرح
INVALID_PARAM_DEFAULT	پارامتر ورودی نامعتبر. برای دریافت جزئیات بیشتر به vendorMsg نگاه کنید.
INVALID_PAGE_TOKEN	PageToken ارائه شده نامعتبر است.
INVALID_CUSTOMER_ID	شناسه مشتری ارائه شده نامعتبر است.
INVALID_DEVICE_IMEI	IMEI نامعتبر است.
INVALID_DEVICE_MEID	MEID نامعتبر است.
INVALID_DEVICE_SERIAL	شماره سریال اشتباه.
INVALID_OPERATION_ID	OperationId ارائه شده نامعتبر است.
INVALID_RESELLER_ID	شناسه Reseller ارائه شده نامعتبر است.
INVALID_MANUFACTURER	سازنده ارائه شده نامعتبر / پشتیبانی نمی شود.
INVALID_IDENTIFIER_SET	مجموعه ای از شناسه های ارائه شده برای درخواست کافی نیست. برای اطلاعات بیشتر در مورد مجموعه‌های شناسه مجاز، به DeviceIdentifier مراجعه کنید.
INVALID_MODEL	مدل ارائه شده نامعتبر / پشتیبانی نمی شود.
INVALID_DEVICE_ID	شناسه دستگاه ارائه شده نامعتبر است.
INVALID_DEVICE	دستگاه ارائه شده وجود ندارد. این یک کد خطای خاص سامسونگ است.
DUPLICATE_DEVICE	این دستگاه قبلاً به همان مشتری ادعا شده بود. هیچ اقدام اصلاحی لازم نیست.
DEVICE_UPLOAD_COUNT_EXCEEDED	این درخواست شامل دستگاه‌های بیشتری است که حد مجاز (در حال حاضر 100 هزار نفر) است.
AUTHORIZATION_FAIL	شما به یک منبع معین (مثلاً دستگاه، مشتری) دسترسی ندارید یا این منبع وجود ندارد. برای دریافت جزئیات بیشتر به vendorMsg نگاه کنید.
INTERNAL_SERVER_ERROR	خطای سرور داخلی نامشخص. برای دریافت جزئیات بیشتر به vendorMsg نگاه کنید. بسته به ماهیت خطای سرور می توان این درخواست ها را دوباره امتحان کرد.
NOT_IMPLEMENTED	روش درخواست توسط سرور پشتیبانی نمی شود.