Search Devices
Description
For a given enterprise account, returns a list of devices that have changed since a specified date. You can filter the list by SIM status.
Resource URL
GET rws/api/v{apiVersion}/devices
Request Parameters
Parameter | Description |
---|---|
apiVersion |
The version number for this API. The current version for all functions is 1. |
accountId |
(Optional) Unique identifier for the account that owns the devices you're searching for. If you omit this parameter, Control Center uses the account associated with the user name. |
modifiedSince | A date and time using the ISO 8601 format. The function returns any devices that have been modified since this time. |
status | (Optional) A SIM status value. The function returns only devices with this status. For a list of valid values, see SIM Status Values. |
pageSize |
(Optional) Specifies the number of records returned in each response page. The maximum value is 50. The value defaults to 50. See Pagination. |
pageNumber |
(Optional) Specifies the number of response pages to return. This value defaults to 1. See Pagination. |
Response Parameters
The function returns an array of devices with the information below. Records are sorted by modification date in ascending order with the oldest device change listed first.
Return Value | Description |
---|---|
devices | The array containing the device list. |
iccid | The ICCID of the device. |
status | The device's SIM status. For a list of valid values, see SIM Status Values. |
ratePlan | The name of the rate plan associated with the device. |
communicationPlan | The name of the communication plan associated with the device. |
pageNumber |
An integer specifying the number of the current response page. |
lastPage |
A true or false value indicating whether the current response page is the last in the series. |
Request Example
Make sure to use your own user credentials. See Authentication for information about creating an authorization header.
Response Example
Code Samples
Make sure to use the Control Center sandbox URL and your own user credentials.
Errors
Error Code | HTTP Code | Error Message |
---|---|---|
10000001 | 401 |
Invalid credentials. Description: Control Center uses this error message when the API credentials are invalid or when the IP address is not within the allowed range. |
10000002 | 400 | AccoundId is required. |
10000003 | 400 | ModifiedSince is required. |
10000004 | 400 | Invalid accountId. |
10000005 | 400 | Invalid status. |
10000006 | 400 | Invalid pageSize. |
10000007 | 400 | Invalid pageNumber. |
10000012 | 400 | Invalid date format. |
10000024 | 400 | Invalid apiVersion. |
30000001 | 500 | Unknown server error. |