Cancel Device Location Report

Cancel a Queued Device Location Report:
DELETE /locationreports/{account}/report/{txid}

Cancel a queued location report that was requested with a POST /locationreports request.

Contents

See also:
Create a Device Location Report
Get Device Location Report Status
Retrieve a Device Location Report

Uses and Requirements

You can only cancel queued reports. Once a report status has changed to INPROGRESS, you cannot cancel it.

Request Components

HTTP Request

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

Resource Path and Query Parameters

You must include the account name and transaction ID in the path.

Parameter Name Data Type Description
account
required
string The name of the account that the report was requested for.
txid
required
string The transaction ID of the report that you want to cancel, from the POST /locationreports response.

Header Parameters

The request header must contain a current ThingSpace authorization bearer token and a valid VZ-M2M session token.

Parameter Name Data Type Description
Authorization
required
string HTTP Authorization bearer token.
VZ-M2M-Token
required
string A valid session token returned by POST /api/m2m/v1/session/login.

Request Body

None.

Success Responses

Status 200

A success response contains the transaction ID of the report that was canceled.

Parameter Name Data Type Description
txid string The transaction ID of the report.

Example Success Response

{
  "txid": "2c90bd28-ece4-42ef-9f02-7e3bd4fbff33"
}

Failure Responses

Status 400

All error messages are returned in this format:

{
  "errorCode": "The type of error, such as INVALID_REQUEST.",
  "errorMessage": "Additional error information."
}

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

Try It Out!