חומרי עזר של החברה
מזהה את החברה באופן ייחודי.
שם השדה | סוג הנתונים | תיאור |
---|---|---|
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
. - למכשירים עם 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 ) |
שגיאת הפעלת המכשיר. |
חריג נפוץ
חריגה שעלולה להיות מוחרגת על ידי כל ממשקי ה-API הסינכרוניים.
שם הנכס | ערך | תיאור |
---|---|---|
error |
object( Error ) |
שגיאת פעולה סינכרונית. |
שגיאה
אובייקט שמכיל פרטים על שגיאה.
שם הנכס | ערך | תיאור |
---|---|---|
code |
enum( ErrorCode ) |
קוד השגיאה. לדוגמה, INVALID_REQUESET או PERMISSION_DENIED |
message |
string |
הודעת השגיאה. |
vendorMsg |
string |
הסבר מפורט על השגיאה שקיבלתם מהספק. |
errorId |
string |
מזהה השגיאה הפנימי. |
vendorParams |
map |
שדות נוספים בצמדי מפתח/ערך שצוינו על ידי הספק. |
קוד שגיאה
שגיאות נפוצות
טיפוסים בני מנייה (Enum) | תיאור |
---|---|
INVALID_PARAM_DEFAULT |
פרמטר קלט לא חוקי לא מוגדר. מידע נוסף זמין בספק הספק (Msg.) |
INVALID_PAGE_TOKEN |
ה-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 |
שגיאת שרת פנימית לא מוגדרת. מידע נוסף זמין בספק הספק Msg. ניתן לנסות לבצע שוב את הבקשות האלה, בהתאם לאופי שגיאת השרת. |
NOT_IMPLEMENTED |
השרת אינו תומך בשיטת הבקשה. |