Premium APIsDevice DiagnosticsAPI EndpointsDiagnostics Settings
API Reference
Get Diagnostics Settings
GET /devices/settings?accountName={account}&devices=[{"id":"{imei1}","kind":"imei"},{"id":"{imei2}","kind":"imei"]
You can retrieve the current diagnostic observation settings for a list of devices.
Uses and Requirements
With this API, you can synchronously retrieve all the diagnostic observation settings and attributes for the requested devices. For each device, the response includes the device id and kind of device, the attributes being observed and the frequency with which each attribute is being observed.
Request Components
HTTP Request
Resource Path and Query Parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| accountName required | string | The name of the billing account for which you want to retrieve diagnostic settings. An account name is usually numeric, and must include any leading zeros. |
| devices required | string | The devices for which you want to retrieve diagnostic settings. Devices list format: [{“id”:“{imei1}”,“kind”:“imei”},{“id”:“{imei2}”,“kind”:“imei”}] |
Header Parameters
The request header must contain a current ThingSpace authorization bearer token and a valid VZ-M2M session token, and must set the content-type to JSON.
| Parameter Name | Data Type | Description |
|---|---|---|
| Authorization required | string | HTTP Authorization bearer token. |
| VZ-M2M-Token required | string | A valid session token returned by POST /session/login. |
| Content-Type required | string | Must be application/json. |
Request Body
None
Success Responses
Status 200
| Parameter Name | Data Type | Description |
|---|---|---|
| accountName | string | The name of the account for which you want retrieve diagnostic settings. An account name is usually numeric, and must include any leading zeros. |
| device | device data object | The devices for which you want to retrieve diagnostic settings. |
| device.id | string | A device identifier value |
| device.kind | string | Type of identifier IMEI ESN MEID |
| attributes | array of objects | Streaming RF parameters for which you want to retrieve diagnostic settings. |
| attributes.name | string | MANUFACTURER DEVICE_TYPE MODEL_NUMBER SERIAL_NUMBER HARDWARE_VERSION FIRMWARE_VERSION SOFTWARE_VERSION AVAILABLE_POWER_SOURCES BATTERY_LEVEL BATTERY_STATUS HOMEOR_ROAM NETWORK_BEARER, AVAILABLE_NETWORK_BEARER RADIO_SIGNAL_STRENGTH LINK_QUALITY CELL_ID SMNC SMCC APN PSM_TIMER ACTIVE_TIMER EDRX_WB_S1 EDRX_NB_S1 HOST_DEVICE_MANUFACTURER HOST_DEVICE_MODEL HOST_DEVICE_ID HOST_DEVICE_FIRMWARE_VERSION HOST_DEVICE_SOFTWARE_VERSION HOST_DEVICE_HARDWARE_VERSION HOST_DEVICE_DATE_STAMP |
| attributes.value | string | |
| attributes.createdOn | string($date-time) | Date and time request was created. |
| attributes.isObservable | boolean | Is the attribute observable? |
| attributes.isObserving | boolean | Is the attribute being observed? |
| attributes.frequency | attributes frequency data object | The frequency with which the attribute is being observed |
| attributes.frequency.value | integer($int32) | |
| attributes.frequency.unit | string | SECOND MINUTE HOUR DAY |
Example Success Response
[
{
"accountName": "string",
"device": {
"id": "864508030026238",
"kind": "IMEI"
},
"attributes": [
{
"name": "MANUFACTURER",
"value": "string",
"createdOn": "2019-09-07T23:08:03.532Z",
"isObservable": true,
"isObserving": true,
"frequency": {
"value": 5,
"unit": "SECOND"
}
}
]
}
]Failure Responses
Status 400 All error messages are returned in this format:
{
"errorCode": "error code string",
"errorMessage": "error message string"
}