Cancel Asyncronous 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 the DELETE request was sent. Only queued requests can be cancelled. Once ThingSpace has started processing the original request, the request cannot be cancelled. Note: Some device location callbacks may be sent for devices that were processed before the DELETE request was received.
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 Name | Data Type | Description |
|---|---|---|
| Authorization (required) | string | HTTP Authorization bearer token: Authorization: Bearer {token} |
| VZ-M2M-Token (required) | string | A valid session token: VZ-M2M-Token: {M2Mtoken} |
| Content-Type (required) | string | Must be application/json Content-Type: application/json |
HTTP Request
DELETE https://thingspace.verizon.com/api/loc/v1/devicelocations/{txid}?accountName={accountName}
Request Parameters
The transaction ID (txid) and accountName must be included in the path.
| Parameter Name | Data Type | Description |
|---|---|---|
| txid (required) | string | The transaction ID of the request to cancel, from the POST /devicelocations synchronus response. This is a 32 or 36-bit UUID. |
| accountName (required) | string | The numeric name of the account that sent the original request. Must include any leading zeros. |
Request Body
None.
Success Response
Status 200 A success response contains the transaction ID of the request that was canceled:
Example Success Response
{
"txid": "2c90bd28-eeee-ffff-gggg-7e3bd4fbff33"
}Sucess Parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| txid | string | The 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.