Near Real-Time Network Conditions
POST /v1/intelligence/network-conditions
Run a report to determine current network condition and availability. This status is updated multiple times per hour.
HTTP Request
POST https://thingspace.verizon.com/api/m2m/v1/intelligence/network-conditions
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. |
Request Body
{
"accountName":"0000123456-00001",
"locationType":"LONGLAT",
"coordinates":{
"latitude":"decimal degrees",
"longitude":"decimal degrees"
}
}Request Body Parameters
All parameters are required unless marked "optional".
| Parameter | Data Type | Description |
|---|---|---|
| accountName | string | The numeric name of the account, including leading zeros. |
| locationType | string | This defines the location information used for a query. The only valid value for this query is LONGLAT. |
| coordinates | object | The coordinates being queried. |
| latitude | string | Latitude in decimal degrees (-90° to 90°). |
| longitude | string | Longitude in decimal degrees (-180° to 180°). |
Success Responses
Status 200
A successful response shows a system generated request ID to track the request.
{
"requestId": "d1f08526-eeee-ffff-gggg-4456490ea9f8"
}Callback Response
These endpoints send responses asynchronously. In order to read the results a callback is required. To learn more about callbacks, please visit About Callback Services. The callback service to subscribe to is IntelligenceService.
Example callback response:
{
"username" : "the user's login information",
"password" : "the user's password",
"requestId" : "d1f08526-eeee-ffff-gggg-4456490ea9f8",
"intelligenceResponse" : {
"networkConditions" : {
"coordinates" : {
"latitude" : "39.750544",
"longitude" : "-104.999429"
},
"color" : "#00FF00",
"score" : "99.94000000000003"
}
},
"status" : "SUCCESS",
"callbackCount" : 1,
"maxCallbackThreshold" : 4
}Callback Parameters
| Parameter | Data Type | Description |
|---|---|---|
| username | string | The user's login information. |
| password | object | The user's password. |
| requestId | string | The requestId being viewed. This is a system generated value from the request above. |
| intelligenceResponse | object | Contains the response details of the request. |
| networkConditions | object | Contains the coordinate queried and a score value of current health. |
| coordinates | object | The coordinates queried. |
| latitude | string | The Latitude in decimal degrees (-90° to 90°). |
| longitude | string | The Longitude in decimal degrees (-180° to 180°). |
| color | string | A color score in hexadecimal indicating network health: Green - #00FF00 - Best Yellow - #FFFF00 - Impacted Red - #FF0000 - Worst |
| score | string | A numeric score, out of 100, indicating network health. 100 maps to green which is the best. |
| status | string | The status of the intelligenceResponse. |
| callbackCount | string | The number of responses for intelligenceResponse found. |
| maxCallbackThreshold | string | The maximum number of responses for intelligenceResponse allowed. |
Failure Responses
All error responses will be in the following format
{
"errorCode": "The 3-digit HTML error code",
"errorMessage": "string"
}