Enable/Disable Hyper Precise on a Device

Enable/Disable Hyper Precise on a Device

PUT /devices/services

Enable/disable hyper-precise service for a device.

Contents

See also:
GET /devices/services - Get the status of the 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

PUT https://thingspace.verizon.com/api/hyper-precise/v1/devices/services

Request Parameters

Parameter Data Type Description
accountNumber
required
string A unique identifier for an account.
deviceList array An array of the following objects
imei
required
string International Mobile Equipment Identifier. The unique ID of a device.
BullseyeEnable
required
Boolean Set to Enable (true) or Disable (false).

Request Body

Example request:

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

Success Response

Status 200

A successful request returns the Hyper Precise status set for that device.

Example response:

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

 

Response Parameters

Parameter Data Type Description
accountNumber string A unique identifier for an account.
deviceList array An array containing the following information:
imei string International Mobile Equipment Identifier. The unique ID of a device.
BullseyeEnable Boolean A flag either set to Enable (true) or Disable (false).
responseType Response Object An object containing the following:
responseCode string An enumerated string containing one of the following responses - INVALID_ACCESS, INVALID_PARAMETER, INTERNAL_ERROR, SUCCESS
.
message string Additional details about the responseCode.

 

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"
}