Specialized APIsSensor InsightsAPI Reference
Get a sensor's offboarding status
POST /dm/v1/devices/sensors/offboard/status/actions/query
Use this endpoint to retrieve the status of a sensor's offboarding progress.
Header Parameters
The request header must set the content-type to JSON, contain a current ThingSpace authorization token and a current VZ-M2M session token. For more details on how to get these tokens, visit Getting Started.
| Parameter Name | Data Type | Description |
|---|---|---|
| Authorization (required) | string | HTTP Authorization request header containing a valid Bearer token: Authorization: Bearer {token} |
| VZ-M2M-Token (required) | string | A valid session token returned by a Connectivity Management POST /session/login request. |
| Content-Type (required) | string | Must be application/json. |
HTTP Request
POST https://thingspace.verizon.com/api/dm/v1/devices/sensors/offboard/status/actions/query
Request Parameters
Note: All parameters are required unless marked (optional)
| Parameter | Data Type | Description |
|---|---|---|
| accountname | string | The numeric name of the account and must include leading zeros. |
| gatewayidentifier | object | Details about the sensor's gateway. |
| deviceid | string | The UUID of the gateway. This is assigned at Onboarding. |
| offboarding | object | An object containing the offboarding details. |
| sensoridentifiers | object | An object conatining details about the sensor being offboarded. |
| deveui | string | The unique EUI64 address of the device. |
Request Body
Example Request:
{
"accountname": "0000123456-00001",
"gatewayidentifier": {
"deviceid": "UUID of the Gateway device"
},
"offboarding": {
"sensoridentifiers": {
"deveui": "The unique EUI64 address of the device"
}
}
}Success Response
Status 200 This is a synchronous response, so the device's offboarding status will be returned, along with any error messages. Example Response:
{
"events": [
{
"createdon": "2023-10-02T15:46:34.562Z",
"errmsg": "provider_service_error",
"fields": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"state": "failed",
"transactionid": "afbcc00d-eeee-ffff-gggg-38b4333fcf06"
}
],
"isstillregistered": true
}Success Parameters
| Parameter | Data Type | Description |
|---|---|---|
| events | array | An array of offboarding status information. |
| createdon | string ($date-time) | The timestamp of when the record was created. |
| errmsg | string | A system generated error message. |
| fields | object | Contains the device configuration details as well as device identifier details. |
| state | string | The status of the onboarding request. This will be success or failed. |
| transactionid | string | The system-generated UUID of the onboarding request. A UUID is a 32 to 36-bit alphanumeric string. |
| isstillregistered | boolean | A flag indicating if the device is still registerd ( true ) or if it has been offboarded ( false ). |
Failure Responses
Example Response:
{
"error": "Error name or code",
"error_description": "A longer error description.",
"cause": "A cause for the error"
}