Get Device Details
Description
Returns detailed information about a specified device.
Resource URL
GET rws/api/v{apiVersion}/devices/{iccid}
Request Parameters
Parameter | Description |
---|---|
apiVersion |
The version number for this API. The current version for all functions is 1. |
iccid | The ICCID of the device you want information about. |
Response Parameters
Return Value | Description |
---|---|
iccid | The ICCID of the device. |
imsi | The device IMSI. |
msisdn | The device MSISDN or phone number. |
imei | The device IMEI. |
status | The device 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. |
customer | The name of the customer (generally an enterprise or business unit), if any, associated with this device. |
endConsumerId | The ID of the person, if any, associated with this device. |
dateActivated | The date when the device was first activated. See Date Formats for more details. |
dateUpdated | The date when the last device information update occurred. See Date Formats for more details. |
dateShipped | The date when the device SIM was transferred from the operator inventory into the enterprise account. See Date Formats for more details. |
accountId | The ID of the enterprise account associated with the device. |
fixedIPAddress |
The IPv4 address assigned to the device. This field may be null if the device communication plan uses dynamic IP addresses or if the device uses an IPv6 address instead. |
fixedIpv6Address | The IPv6 address assigned to the device. This field may be null if the device communication plan uses dynamic IP addresses or if the device uses an IPv4 address instead. |
operatorCustom1-5 | Values for any custom device fields the operator has created in Control Center. This information is applicable to users with operator roles only. |
accountCustom1-10 | Values for any custom device fields the enterprise has created in Control Center. This information is applicable to users with account roles only. |
customerCustom1-5 | Values for any custom device fields the customer has created in Control Center. This information is applicable to users with customer roles only. |
simNotes | Information the operator has added about the device. |
deviceID | Optional identifier that an account or customer can give to a device. |
modemID | Identifies the modem used by the device to transmit data. |
globalSIMType | For enterprises taking advantage of Control Center's Global SIM feature, this value indicates whether the device is using a primary SIM from the lead operator or a virtual subscription from a partner operator. |
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. |
10000024 | 400 | Invalid apiVersion. |
20000001 | 404 | Resource not found - Invalid ICCID. |
30000001 | 500 | Unknown server error. |