AI-generated Key Takeaways
-
This asynchronous API allows you to claim up to 100,000 devices for one or more customers.
-
Each request using the
ResellerService
class supports claiming devices for only one customer; attempting to claim for multiple customers will result in anINTERNAL_SERVER_ERROR
. -
The asynchronous method
claimDevicesAsync
returns a result before processing is complete, and you must usegetOperation
to periodically check the status. -
The
ClaimDevicesRequest
requires a list ofDeviceClaim
objects, and eachDeviceClaim
must include aDeviceIdentifier
andCompanyReference
for the customer. -
Potential error codes include
DEVICE_UPLOAD_COUNT_EXCEEDED
,DUPLICATE_DEVICES
,INTERNAL_SERVER_ERROR
, and variousINVALID
errors related to customer, device identifiers, and device information.
Asynchronous request to claim up to 100,000 devices for one or more customers.
Asynchronous API methods return a result before the processing is complete. They
also help your app (or tool) remain responsive for your users while they wait
for a long-running operation to complete. Your app should call
getOperation
to check the status of the operation periodically.
Method signature
public ClaimDevicesResponse claimDevicesAsync(ClaimDevicesRequest request);
ClaimDeviceRequest
Property name | Value | Required | Description |
---|---|---|---|
claims |
List of object(DeviceClaim) |
Yes | List of device claims to claim for the customer. |
DeviceClaim
Property name | Value | Required | Description |
---|---|---|---|
deviceIdentifier |
object( DeviceIdentifier ) |
Yes | Device identifier. |
customer |
CompanyReference object |
Yes | Company reference for the customer that the device is assigned to. |
orderNumber |
string |
No | Order number. |
vendorParams |
map |
No | Extra fields, vendor specified key-value pair. |
ClaimDeviceResponse
Property name | Value | Description |
---|---|---|
operations |
List of Operation objects |
One or more ClaimDevices Operation instances. |
Error behavior
If an error occurs, the Operation
object returns one of the following error
codes:
Error code |
---|
DEVICE_UPLOAD_COUNT_EXCEEDED |
DUPLICATE_DEVICES |
INTERNAL_SERVER_ERROR |
INVALID_CUSTOMER_ID |
INVALID_DEVICE_IMEI |
INVALID_DEVICE_MEID |
INVALID_DEVICE_SERIAL |
INVALID_IDENTIFIER_SET |
INVALID_MANUFACTURER |
INVALID_MODEL |