אובייקטים

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 שדות נוספים בצמדי מפתח/ערך שצוינו על ידי הספק.

DeviceIdentifier

כולל מזהי חומרה ומוצרים כדי לזהות את המכשיר של היצרן.

במכשירי Samsung נדרש אחד מהשדות הבאים:

  • IMEI
  • serialNumber
  • meid

המערכת מתעלמת מכל שאר השדות, כמו model.

בכל שאר מכשירי Android:

  • למכשירים סלולריים נדרשים imei ו-manufacturer.
  • למכשירים עם Wi-Fi בלבד נדרשים 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 שדות נוספים בצמדי מפתח/ערך שצוינו על ידי הספק.

DeviceOperationError

שגיאה ספציפית למכשיר ב-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 שדות נוספים בצמדי מפתח/ערך שצוינו על ידי הספק.

ErrorCode

שגיאות נפוצות.

Enum תיאור
INVALID_PARAM_DEFAULT פרמטר הקלט לא צוין. לקבלת פרטים נוספים, אפשר לעיין ב-providerMsg.
INVALID_PAGE_TOKEN אסימון הדף שסופק אינו חוקי.
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,000).
AUTHORIZATION_FAIL אין לך גישה למשאב נתון (למשל, מכשיר או לקוח), או שהמשאב לא קיים. לפרטים נוספים, אפשר לעיין ב-vendorMsg.
INTERNAL_SERVER_ERROR שגיאת שרת פנימית לא מזוהה. לפרטים נוספים אפשר לעיין ב-providerMsg. אפשר לנסות לנסות שוב את הבקשות האלה בהתאם לאופי של שגיאת השרת.
NOT_IMPLEMENTED השרת לא תומך בשיטת הבקשה.