Specialized APIsThingSpace Connection PlannerStatus of Devices for Connection Planner
API Reference
Connection Planner Status of Devices
POST /v1/intelligence/device/connection-planner/status
Use this API endpoint to verify the status of devices using the Connection Planner service.
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 how to obtain tokens .
| 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/v1/intelligence/device/connection-planner/status
Request Parameters
| Parameter | Data Type | Description |
|---|---|---|
| accountNumber (required) | string | The numeric name of the account, including leading zeros. |
| requestId (required) | string | The UUID of the window request. |
| devices (optional) | array | An array of deviceId values. |
deviceIds (required for devices) | array | An array of kind/id pairs used to identify devices on the account. |
id (required for devices) | string | The value of the kind used. |
kind (required for devices) | string | The kind of device identifier. The example uses Integrated Cicuit Chip ID (ICCID). |
Request Body
Example Request:
{
"accountNumber": "0000123456-00001",
"requestId": "d1f08526-eeee-ffff-gggg-4456490ea9f8",
"devices": [
{
"deviceIds": [
{
"id": "20-digit ICCID",
"kind": "iccid"
}
]
}
]
}Success Response
Status 200 A successful request returns the device status. Example Response:
{
"accountNumber": "0000123456-00001",
"requestId": "d1f08526-eeee-ffff-gggg-4456490ea9f8",
"devices": [
{
"deviceIds": [
{
"id": "20-digit ICCID",
"kind": "iccid"
}
]
},
"status": "SUCCESS",
"reason": "Device Data Found",
}
],
"errorCode": "Error Code",
"errorMessage": "Error Message"
}Success Parameters
| Parameter | Data Type | Description |
|---|---|---|
| accountNumber | string | The numeric name of the account, including leading zeros. |
| requestId | string | A unique identifier (UUID) of the request made. |
| devices | array | An array of deviceId values. |
| deviceIds | array | An array of kind/id pairs used to identify devices on the account. |
| id | string | The value of the kind used. |
| kind | string | The kind of device identifier. The example uses Integrated Cicuit Chip ID (ICCID). |
| status | string | Status of the request. This will be SUCCESS or FAILED. |
| reason | string | A brief message about the status for more detail. |
| errorCode | string | A 3-digit or 4-digit code. |
| errorMessage | string | A brief description of the error. |
Failure Responses
Example Response:
{
"errorCode": "string",
"errorMessage": "string",
"errorUrl": "string"
}