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की ज़रूरत है.
- सिर्फ़ वाई-फ़ाई वाले डिवाइसों के लिए, serialNumber,manufacturer, औरmodelज़रूरी हैं.
| फ़ील्ड का नाम | डेटा टाइप | ब्यौरा | 
|---|---|---|
| imei | string | डिवाइस का IMEI नंबर. इनपुट के आधार पर पुष्टि की गई. | 
| serialNumber | string | डिवाइस के लिए मैन्युफ़ैक्चरर का सीरियल नंबर. यह मान शायद अलग-अलग डिवाइस मॉडल के लिए अलग-अलग न हो. | 
| meid | string | डिवाइस का MEID नंबर. | 
| manufacturer | string | डिवाइस बनाने वाली कंपनी का नाम. android.os.Build.MANUFACTURERसे लौटाए गए, डिवाइस में पहले से मौजूद वैल्यू से मेल खाता है. जिन वैल्यू की अनुमति है उनकी जानकारी मैन्युफ़ैक्चरर की सूची में दी गई है. | 
| model | string | डिवाइस के मॉडल का नाम. android.os.Build.MODELसे लौटाए गए, डिवाइस में पहले से मौजूद वैल्यू से मेल खाता है. जिन वैल्यू को अनुमति दी गई है उन्हें मॉडल की सूची में शामिल किया गया है. | 
कार्रवाई
इस संसाधन में एसिंक्रोनस एपीआई कॉल की स्थिति शामिल है. कुल चार संभावित स्थितियां:
- IN_PROGRESS: कार्रवाई चल रही है.
- COMPLETE: सभी डिवाइस प्रोसेस हो गए.
- COMPLETE_WITH_ERRORS: कार्रवाई पूरी हुई, लेकिन कुछ गड़बड़ियां हुईं. सभी गड़बड़ियां- deviceErrorsसूची में शामिल की जाती हैं.
- FAILED: कार्रवाई नहीं हो सकी और कोई- operationIdवापस नहीं मिली.
| फ़ील्ड का नाम | डेटा टाइप | ब्यौरा | 
|---|---|---|
| operationId | string | ऑपरेशन आईडी, जिसकी शुरुआत में samsung/याgoogle/है. अगर खाली है,तोstateFAILEDहै. | 
| 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 | अमान्य इनपुट पैरामीटर तय नहीं किया गया है. ज़्यादा जानकारी पाने के लिए, sellersMsg पर जाएं. | 
| INVALID_PAGE_TOKEN | दिया गया pageToken अमान्य है. | 
| INVALID_CUSTOMER_ID | दिया गया ग्राहक आईडी अमान्य है. | 
| INVALID_DEVICE_IMEI | गलत IMEI. | 
| INVALID_DEVICE_MEID | अमान्य MEID. | 
| INVALID_DEVICE_SERIAL | अमान्य सीरियल नंबर. | 
| INVALID_OPERATION_ID | दिया गया OperationsId अमान्य है. | 
| INVALID_RESELLER_ID | आपने जो रीसेलर आईडी दिया है वह अमान्य है. | 
| INVALID_MANUFACTURER | मैन्युफ़ैक्चरर की दी गई जानकारी अमान्य है या इस्तेमाल नहीं की जा सकती. | 
| INVALID_IDENTIFIER_SET | आइडेंटिफ़ायर का दिया गया सेट, अनुरोध के लिए काफ़ी नहीं है. आइडेंटिफ़ायर के स्वीकार किए गए सेट के बारे में ज़्यादा जानकारी के लिए, DeviceIdentifierपर जाएं. | 
| INVALID_MODEL | दिया गया मॉडल अमान्य है / काम नहीं करता है. | 
| INVALID_DEVICE_ID | दिया गया deviceId अमान्य है. | 
| INVALID_DEVICE | दिया गया डिवाइस मौजूद नहीं है. यह Samsung का गड़बड़ी का कोड है. | 
| DUPLICATE_DEVICE | इस डिवाइस पर पहले भी इसी ग्राहक ने दावा किया है. सुधार के लिए कोई कार्रवाई करने की ज़रूरत नहीं है. | 
| DEVICE_UPLOAD_COUNT_EXCEEDED | अनुरोध में ऐसे और डिवाइस शामिल हैं जिनकी सीमा अभी 1 लाख है. | 
| AUTHORIZATION_FAIL | आपके पास किसी संसाधन (जैसे कि डिवाइस, ग्राहक) का ऐक्सेस नहीं है या वह संसाधन मौजूद नहीं है. ज़्यादा जानकारी पाने के लिए, vendorMsgदेखें. | 
| INTERNAL_SERVER_ERROR | सर्वर की अनजान गड़बड़ी. ज़्यादा जानकारी पाने के लिए वेंडरMsg पर जाएं. सर्वर की गड़बड़ी किस तरह की है, इसके आधार पर इन अनुरोधों को फिर से करने की कोशिश की जा सकती है. | 
| NOT_IMPLEMENTED | अनुरोध का तरीका सर्वर पर काम नहीं करता. |