Specialized APIsHyper Precise LocationAPI EndpointsDevice Service Management for Hyper PreciseUpdate Service Status
API Reference
Update the Status of Hyper Precise on a Device
PUT /devices/services
Changes the status of the Hyper Precise Location service on a device to enable or disable service.
HTTP Request
PUT https://thingspace.verizon.com/api/hyper-precise/v1/devices/services
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 Parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| accountNumber (required) | string | The account the device belongs to. |
| imei (required) | string | The International Mobile Equipment Identifier of the device. |
| BullseyeEnable | Boolean | Shows if Hyper Precise is enabled (true) or disabled (false). |
Request Body
{
"deviceList": [
{
"imei": "15-digit IMEI",
"BullseyeEnable": {true or false}
}
],
"accountNumber": "0000123456-00001"
}Success Response
Status 200
A successful request returns the status of Hyper Precise Location on the device
Example Response:
{
"accountNumber": "0000123456-00001",
"deviceList": [
{
"imei": "15-digit IMEI",
"BullseyeEnable": {true or false}
}
],
}Response Parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| accountNumber | string | The account the device belongs to. |
| deviceList | array | An array of the following parameters: |
| imei | string | The International Mobile Equipment Identifier of the device. |
| BullseyeEnable | Boolean | Shows if Hyper Precise is enabled (true) or disabled (false). |
Failure Responses
400 - Bad Request.
{
"errorCode": "INVALID_PARAMETER",
"errorMessage": "Device Not Found, Request will be queued"
}401 - Unauthorized request. Access token is missing or invalid.
{
"errorCode": "INVALID_ACCESS",
"errorMessage": "The access policy denied the resource operation for this user"
}403 - Forbidden request.
{
"errorCode": "INVALID_PARAMETER",
"errorMessage": "Device Not Certified"
}404 - Bad request. Not found.
{
"errorCode": "INVALID_PARAMETER",
"errorMessage": "Device inactive"
}409 - Bad request. Conflict state.
{
"errorCode": "INVALID_PARAMETER",
"errorMessage": "Service Not Purchased"
}500 - Internal Server Error.
{
"errorCode": "INTERNAL_ERROR",
"errorMessage": "Device is active in several accounts"
}