Get the Status of Hyper Precise on a Device

Get the Status of Hyper Precise on a Device

GET /devices/services

Gets the status of the Hyper Precise Location service on a device

Contents

See also:
PUT /devices/services - Enable/Disable Hyper Precise Location service on a device

Request Components

A vz-m2m-token is required to use these APIs. To obtain a token, please visit Getting Started to get a token.

HTTP Request

GET https://thingspace.verizon.com/api/hyper-precise/v1/devices/services?imei={imei}&accountNumber={accountNumber}

Request Parameters

Parameter Data Type Description
accountNumber
required
string The account the device belongs to.
imei
required
string The International Mobile Equipment Identifier of the device.

Request Body

Example request:

curl -X 'GET' \
  'https://thingspace.verizon.com/api/hyper-precise/v1/devices/services?imei={imei}&accountNumber={accountNumber}' \
  -H 'accept: application/json' \
  -H 'VZ-M2M-Token: {token}'

Success Response

Status 200

A successful request returns the status of Hyper Precise Location on the device

Example Response:

{
  "accountNumber": "string",
  "deviceList": [
    {
      "imei": "string",
      "BullseyeEnable": true
    }
  ],
}

Response Parameters

Parameter 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

Code and Meaning Format
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"
}