AI-generated Key Takeaways
-
This API method
findDevicesByOwner
retrieves a list of devices associated with specified customers. -
The request requires a list of up to 100
customers
(CompanyReference objects), and supports pagination viapageSize
andpageToken
. -
The response includes a list of
devices
, thetotalCount
of matching devices, and anextPageToken
for subsequent pages. -
Optional parameters such as
vendorParams
allow for extra, vendor-specific data to be sent and received. -
The API method may throw a
CommonException
with anAUTHORIZATION_FAILED
,INTERNAL_SERVER_ERROR
, orINVALID_PAGE_TOKEN
error code if an error is encountered.
Lists devices claimed by the specified customer or customers.
Method signature
public FindDevicesResponse findDevicesByOwner(FindDevicesByOwnerRequest request) throws CommonException;
FindDevicesByOwnerRequest
Property name | Value | Required | Description |
---|---|---|---|
customers |
object( CompanyReference ) |
Yes | List of up to 100 customers. |
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 behaviour
If an error occurs, the library throws a CommonException
containing one of the
following error codes:
Error code |
---|
AUTHORIZATION_FAILED |
INTERNAL_SERVER_ERROR |
INVALID_PAGE_TOKEN |