Analysis Cancellation

Service version: 1
Last edit: 2022.08.22

Purpose

Send a POST request to cancel an analysis.

Request data

HTTPS Method: POST

For ease of viewing and identification:

  • Constants and 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://{baseURL}/origindestination/{versionNumber}/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

baseURL
string

The base URL for calling TomTom services.


Value: api.tomtom.com

versionNumber
string

Version of the service to call.


Value: The current value is 1.

id
integer

Analysis number id.


Value: The analysis number id.

key
string

Authorization key for access to the API.


Value: Your valid API Key.

Required POST Headers

Header

Value

Content-Type

application/json

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

201 Created
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found