Analysis Cancellation
Purpose
Send a POST request to cancel an analysis.
An analysis can be canceled only while it is in the WAITING or RUNNING status. Canceling stops
the calculation and moves the analysis to CANCELLED. The request has no body and a successful
response has no body either.
Request data
HTTPS Method: POST
For ease of viewing and identification:
- Parameters enclosed in curly brackets { } must be replaced with their values.
- Please see the following Request parameters section with the required and optional parameters tables for their values. The generic request format is as follows.
Format
post
URL request format
https://api.tomtom.com/origindestination/1/analysis/{id}/cancel?key={Your_API_Key}Example
post
URL request example
https://api.tomtom.com/origindestination/1/analysis/512/cancel?key={Your_API_Key}Request parameters
Required parameters | Description |
|---|---|
| Analysis number id. Value: The analysis number id. |
| Authorization key for access to the API. Value: Your valid API Key. |
Response data
Errors
If there is an error in the supplied parameters or any other internal problem, an error response is generated in the requested format.
Response codes
Code | Meaning & possible causes |
|---|---|
| OK |
| Bad Request |
| Unauthorized |
| Forbidden |
| Not Found |