findDevicesByIdentifier

  • This method retrieves a list of devices based on a provided device identifier.

  • The request requires a deviceIdentifier object, which can be partially filled, to specify the devices to be retrieved.

  • Optional parameters include pageSize (up to 100), pageToken for pagination, and vendorParams for extra data.

  • The response contains a list of devices, the totalCount of matching devices, an optional nextPageToken for additional pages, and vendorParams for extra information.

  • Potential errors during the process will result in a CommonException being thrown, with possible error codes being INTERNAL_SERVER_ERROR or INVALID_PAGE_TOKEN.

Lists devices with given device identifier.

Method signature

public FindDevicesResponse findDevicesByDeviceIdentifier(FindDevicesByDeviceIdentifierRequest request)  throws CommonException;

FindDevicesByDeviceIdentifierRequest

Property name Value Required Description
deviceIdentifier object(DeviceIdentifier) Yes Device identifier of the devices to be retrieve. The object can be partially populated.
pageSize int No The page size, up to 100. If greater than 100 or null, 100 is used.
pageToken string No The page token. If empty, the first page is returned.
vendorParams map No Extra fields, vendor specified key-value pair.

FindDevicesResponse

Property name Value Description
devices object(Device) The list of devices uploaded by the reseller. Empty if there is no match.
totalCount int The total count of devices matching the request.
nextPageToken strong The next page token. Empty for the last page.
vendorParams map Optional. 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
INTERNAL_SERVER_ERROR
INVALID_PAGE_TOKEN