unclaimDevice

  • This method unclaimDevice allows for the synchronous unclaiming of a single device from a customer.

  • The ResellerService class does not support this API; users should utilize unclaimDeviceAsync instead.

  • The request requires a DeviceUnclaim object, which must include either deviceId or deviceIdentifier.

  • Errors are communicated through a CommonException, with potential error codes like AUTHORIZATION_FAIL or INVALID_DEVICE_IMEI.

  • vendorParams, are an optional field for vendor-specific key-value pairs related to the unclaim request.

Synchronous request to unclaim a single device from a customer.

Method signature

public void unclaimDevice(UnclaimDeviceRequest request) throws CommonException;

UnclaimDeviceRequest

Property name Value Required Description
unclaim object(DeviceUnclaim) Yes The device unclaim to be processed.

DeviceUnclaim

You must specify deviceId or deviceIdentifier.

Property name Value Required Description
deviceId string No The device ID.
deviceIdentifier object(DeviceIdentifier) No The device identifier.
vendorParams map No Extra fields, vendor specified key-value pair.

Error behavior

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

Error code
AUTHORIZATION_FAIL
INVALID_DEVICE_IMEI
INVALID_DEVICE_MEID
INVALID_DEVICE_SERIAL
INVALID_IDENTIFIER_SET
NOT_IMPLEMENTED