Cancel Asynchronous Device Location Request

Cancel an Asynchronous Device Location Request:
DELETE /devicelocations/{txid}?accountname={accountname}

Cancel a queued POST /devicelocations request. Callback messages will not be sent for any devices that have not been located when you send the DELETE request.

Contents

See also:
Get the location of IoT or consumer devices

Uses and Requirements

You can only cancel queued requests. Once ThingSpace has started processing the original request, you cannot cancel the request. Some device location callbacks may be sent for devices that were processed before the DELETE request was received.

Request Components

HTTP Request

DELETE https://thingspace.verizon.com/api/loc/v1/devicelocations/{txid}?accountname={accountname}

Resource Path and Query Parameters

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

Parameter Name Data Type Description
txid
required
string The transaction ID of the request that you want to cancel, from the POST /devicelocations synchronus response.
accountname
required
string The name of the account that sent the original request.

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 request 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!