accountclientid | string | No | Not used in this release, future functionality |
billingaccountid | string | No | The billing account ID. This is the same value as the Account ID |
chipset | string | No | The Identifier of chipset used by the device |
commands | object | No | |
createdon | string (date-time) | Yes | Timestamp of the record |
customdata | object | No | Name/value pair, where the value is client defined. The purpose is to keep track of current state per device action. |
description | string | No | a short description |
esn | integer (uint64) | No | The Electronic Serial Number (ESN) of the device |
fields | object | No | Fields to return needed by search |
foreignid | string | Yes | UUID of the ECPD account the user belongs to |
hardwareversion | string | No | The manufacturer's hardware version of the device |
iccid | string | No | The 20-digit Integrated Circuit Card ID (SIM card ID) |
id | string | No | UUID of the user record, assigned at creation |
imei | integer (uint64) | No | The 15-digit International Mobile Equipment ID |
imsi | integer (uint64) | No | The 64-bit International Mobile Subscriber Identity |
lastupdated | string (date-time) | Yes | Timestamp of the record |
licenses | array | No | licenses assigned to the device |
mac | string | No | The Media Access Control address of the device, listed on the device in the format XX-XX-XX-XX-XX-XX or XX:XX:XX:XX:XX:XX |
manufacturer | string | No | The manufacturer of the device |
meid | string | No | The 56-bit Mobile Equipment ID |
modelmetadata | object | No | Detail |
msisdn | string | No | The Mobile Station International Subscriber Directory Number. In the USA, this is 1+ a 10-digit phone number |
name | string | No | User defined name of the record |
parentdeviceid | string | No | this field is applicable for BLE sensors. This represents the value of parent gateway device |
productmodel | string | No | The device model name |
providerid | string | No | The id of the provider who is responible for talking to the device |
qrcode | string | No | The numeric value of the Quick Response (QR) code |
refid | string | No | The device reference ID |
refidtype | string | No | The type of value represented by refid |
serial | string | No | The device's serial number |
services | array | No | |
sku | string | No | The Stock Keeping Unit (SKU) number of the device |
softwareversion | string | No | the current device software version |
state | string | Yes | The current status of the device or transaction and will be success or failed |
version | string | No | The resource version |
versionid | string | Yes | The UUID of the resource version |