Analysis Accepting
Purpose
Accept an analysis by sending a POST request.
An analysis can be accepted only from the ENDED status, and accepting it moves it to ACCEPTED.
Accepting consumes the analysis against the limits granted to your contract; the results of the
analysis become available to you at this point. 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
https://api.tomtom.com/origindestination/1/analysis/{id}/accept?key={Your_API_Key}Example
https://api.tomtom.com/origindestination/1/analysis/512/accept?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.
Two situations produce a 400 response:
- The analysis is not in the
ENDEDstatus. - Accepting the analysis would exceed a consumable limit granted to your contract. The response names the limit.
Response codes
Code | Meaning & possible causes |
|---|---|
| OK |
| Bad Request |
| Unauthorized |
| Forbidden |
| Not Found |