Specialized APIsHyper Precise LocationAPI EndpointsHyper Precise Location CallbacksDeregister a Callback Listener

API Reference

Delete a Callback Listener

DELETE /callbacks

Stops ThingSpace from sending callback messages for the specified account and listener name.

HTTP Request

DELETE https://thingspace.verizon.com/api/hyper-precise/v1/callbacks?accountNumber={accountNumber}&name={name}

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 NameData TypeDescription
Authorization (required)stringHTTP Authorization request header containing a valid Bearer token: Authorization: Bearer {token}
VZ-M2M-Token (required)stringA valid session token returned by a Connectivity Management POST /session/login request.
Content-Type (required)stringMust be application/json.

Request Parameters

ParameterData TypeDescription
accountNumber (required)stringA unique identifier for an account..
name (required)stringThe name of the callback listener that will be deleted.

Request Body

None.

Success Responses

Status 200

A successful request returns a responseCode and/or a message indicating success or failure of the request

Example response:

{
  "responseCode": "string",
  "message": "string"
}

Success Parameters

ParameterData TypeDescription
responseCodestringAn enumerated string with one of the following values: INVALID_ACCESS, INVALID_PARAMETER, INTERNAL_ERROR, SUCCESS.
messagestringMore details about the responseCode received.

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

On this page