Premium APIsDevice LocationAPI Reference

Cancel Device Location Report

Cancel a Queued Device Location Report

DELETE /locationreports/{accountName}/report/{txid}

Cancel a queued location report that was requested with a POST /locationreports request. Note: Only queued reports can be cancelled. Once a report status has changed to INPROGRESS, it cannot be cancelled.

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 bearer token: Authorization: Bearer {token}
VZ-M2M-Token (required)stringA valid session token: VZ-M2M-Token: {M2Mtoken}
Content-Type (required)stringMust be application/json Content-Type: application/json

HTTP Request

DELETE https://thingspace.verizon.com/api/loc/v1/locationreports/{accountName}/report/{txid}

Request Parameters

The accountName and transaction ID (txid) must be included in the path.

Parameter NameData TypeDescription
accountName (required)stringThe numeric name of the account that the report is requested for.
txid (required)stringThe transaction ID of the report to cancel, from the POST /locationreports response. This is a 32 or 36-bit UUID.

Request Body

None.

Success Response

Status 200 A success response contains the transaction ID of the report that was canceled: Example Success Response

{
  "txid": "2c90bd28-eeee-ffff-gggg-7e3bd4fbff33"
}

Success Parameters

Parameter NameData TypeDescription
txidstringThe transaction ID of the report. This is a 32 or 36-bit UUID.

Failure Responses

All error messages are returned in this format:

{
  "errorCode": "The 3-digit HTML error code",
  "errorMessage": "string"
}

Error codes and messages are listed on the Error Codes page, along with explanations and suggestions for corrective actions.

On this page