unclaimDevicesAsync

  • This API provides an asynchronous method to unclaim up to 100,000 devices from one or more customers.

  • The unclaimDevicesAsync method is used to initiate the unclaiming process, and it allows your application to remain responsive during long operations.

  • The ResellerService only allows unclaiming for one customer per request and will fail with INTERNAL_SERVER_ERROR if multiple customer IDs are in a single request.

  • The UnclaimDevicesRequest requires a list of DeviceUnclaim objects and may include vendor-specific parameters, while requests from the SamsungResellerServiceFactory must specify a customerId.

  • The getOperation method can be used to check the status of the UnclaimDevices operation, which can return a list of error codes if an issue happens.

Asynchronous request to unclaim 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 UnclaimDevicesResponse unclaimDevicesAsync(UnclaimDevicesRequest request);

UnclaimDevicesRequest

Property name Value Required Description
unclaims List of object(DeviceUnclaim) Yes The device unclaims to be processed.
vendorParams map No Extra fields, vendor specified key-value pair. Note: Requests from the ResellerService class created by SamsungResellerServiceFactory must specify a customerId in vendorParams.

UnclaimDevicesResponse

Property name Value Description
operations List of object(Operation) One or more UnclaimDevices Operation instances.

Error behavior

If an error occurs, the Operation object returns one of the following error codes:

Error code
DEVICE_UPLOAD_COUNT_EXCEEDED
INTERNAL_SERVER_ERROR
INVALID_DEVICE_IMEI
INVALID_DEVICE_MEID
INVALID_DEVICE_SERIAL
INVALID_IDENTIFIER_SET