claimDevice

  • This API allows a synchronous request to claim a single device for a specific customer, utilizing the claimDevice method.

  • The claimDevice method requires a ClaimDeviceRequest object, which must include a DeviceClaim object containing the device identifier and customer details.

  • The DeviceClaim object necessitates a DeviceIdentifier and a CompanyReference object, optionally accepting an order number and vendor-specific parameters.

  • The claimDevice method returns a ClaimDeviceResponse containing the device ID, prefixed with either 'samsung/' or 'google/'.

  • The API can throw a CommonException with various error codes, including AUTHORIZATION_FAIL, DUPLICATE_DEVICES, and several INVALID_* errors, indicating potential issues with the request.

Synchronous request to claim a single device for a specified customer.

Method signature

public ClaimDeviceResponse claimDevice(ClaimDeviceRequest request) throws CommonException;

ClaimDeviceRequest

Property name Value Required Description
claim DeviceClaim object Yes The device claim to be processed.

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
deviceId string The device ID, prefixed with 'samsung/' or 'google/'.

Error behavior

If an error occurs, the library throws a CommonException containing one of the following error codes:

Error code
AUTHORIZATION_FAIL
DUPLICATE_DEVICES
INVALID_CUSTOMER_ID
INVALID_DEVICE_IMEI
INVALID_DEVICE_MEID
INVALID_DEVICE_SERIAL
INVALID_IDENTIFIER_SET
INVALID_MANUFACTURER
INVALID_MODEL
NOT_IMPLEMENTED