Asynchronous Batch Submission
Service version: 1
Last edit: 2019.11.29
On this page
Purpose
The Asynchronous Batch Submission endpoint allows the submission of a new batch for asynchronous processing. It responds with a redirect to the location at which the batch results can be obtained when the batch processing has completed.
Request data
HTTPS Method: POST
URL format
For ease of viewing and identification:
- Required constants and parameters are shown in bold text.
- Optional parameters are shown in plain text.
https://baseURL/routing/versionNumber/batch/outputFormat?key=Your_API_Key&redirectMode=redirectMode&waitTimeSeconds=waitTimeSeconds
Example
https://api.tomtom.com/routing/1/batch/json?key=Your_API_Key
HTTP Request headers
The following data table describes HTTP Request headers of particular interest to Batch service clients.
Required headers | |
---|---|
Header | Description |
Content-Type string |
Specifies the MIME type of the body of the Request. It may be:
|
Optional headers | |
Header | Description |
Tracking-ID string |
Specifies an identifier for the Request.
Value: An identifier for the Request. |
Request parameters
The following table describes the Request parameters.
- Required parameters must be used or the call will fail.
- Optional parameters may be used.
- A parameter's data type is beneath its name.
Required parameters | |
---|---|
Parameter | Description |
baseURL string |
Base URL for calling the API: Value: api.tomtom.com |
versionNumber string |
Service version. Value: The current value is 1 . |
key string |
An API Key valid for the requested service. Value: Your valid API Key . |
Optional parameters | |
Parameter | Description |
outputFormat string |
The content type of the Response structure. If it is not provided, then xml is assumed as default.Value: It may be either:
|
redirectMode string |
Controls the HTTP code of the successful HTTP Response to the Submission Request. Value:
In both cases the same |
waitTimeSeconds integer |
Allows changing the maximum amount of time, in seconds, for which the client may have to wait for an Asynchronous Batch Download Response while the batch is being calculated. Please note that provided Default value: |
Supported Routing API suite endpoints
A list of Routing API suite endpoints supported by the Batch Routing service can be found below. For details regarding particular API usage, consult the following respective API documentation pages:
POST body
The POST body of a batch Request should contain a set of items which will be used to execute requests to supported endpoints of the Routing API suite.
Each batch Request can contain items corresponding to multiple supported endpoints of the Routing API suite. For each endpoint, the same body structure applies and specific parameters of each endpoint are expected to go into query
elements.
POST body (XML)
<?xml version="1.0" encoding="utf-8"?>
<batchRequest>
<batchItems>
<batchItem>
<query>...</query>
</batchItem>
...
<batchItem>
<query>...</query>
<post>...</post>
</batchItem>
</batchItems>
</batchRequest>
POST body (JSON)
{
"batchItems": [
{"query": "..."},
...
{
"query": "...",
"post": {...}
}
]
}
POST body fields
Field | Description |
---|---|
batchRequest |
Root element of the Request. Value: The XML root element. |
batchItems |
A set of batch items. Value: The maximum number of batch items for an Asynchronous API is 700 . |
batchItem |
A single batch item. Value: One batch item. |
query |
A string used to build a request to one of the supported endpoints of the Routing API suite.
Value: When posting XML to the Batch Routing service, the <query> element values must be valid XML (e.g., the & character must be replaced by the predefined XML entity &). More information is available in the List of XML character entity references. Please note that the |
post |
Contains data that is passed to the Calculate Route or Calculate Reachable Range services using the HTTP POST method.
|
POST body examples
Click to expand/collapse the following examples:
Mixed endpoint examples
XML body example
<?xml version="1.0" encoding="utf-8"?>
<batchRequest>
<batchItems>
<batchItem>
<query>/calculateRoute/52.36006039665441,4.851064682006836:52.36187528311709,4.850560426712036/xml?travelMode=car&routeType=fastest&traffic=true&departAt=now&maxAlternatives=0</query>
</batchItem>
<batchItem>
<query>/calculateRoute/52.36241907934766,4.850034713745116:52.36173769505809,4.852169752120972/xml?travelMode=teleport&routeType=fastest&traffic=true&departAt=now</query>
</batchItem>
<batchItem>
<query>/calculateRoute/52.23292,21.06179:43.29379,17.01963/xml</query>
<post>
<postData>
<avoidVignette>
AUS,CHE
</avoidVignette>
</postData>
</post>
</batchItem>
<batchItem>
<query>/calculateReachableRange/52.36187528311709,4.850560426712036/xml?fuelBudgetInLiters=20&constantSpeedConsumptionInLitersPerHundredkm=50,6</query>
<post>
<postData>
<avoidVignette>
NLD
</avoidVignette>
</postData>
</post>
</batchItem>
<batchItem>
<query>/calculateReachableRange/52.36173769505809,4.852169752120972/xml?timeBudgetInSec=1800</query>
</batchItem>
</batchItems>
</batchRequest>
JSON body example
{
"batchItems": [
{"query": "/calculateRoute/52.36006039665441,4.851064682006836:52.36187528311709,4.850560426712036/json?travelMode=car&routeType=fastest&traffic=true&departAt=now&maxAlternatives=0"},
{"query": "/calculateRoute/52.36241907934766,4.850034713745116:52.36173769505809,4.852169752120972/json?travelMode=teleport&routeType=fastest&traffic=true&departAt=now"},
{
"query": "/calculateRoute/52.23292,21.06179:43.29379,17.01963/json",
"post": {
"avoidVignette": [
"AUS",
"CHE"
]
}
},
{
"query": "/calculateReachableRange/52.36187528311709,4.850560426712036/json?fuelBudgetInLiters=20&constantSpeedConsumptionInLitersPerHundredkm=50,6",
"post": {
"avoidVignette": [
"NLD"
]
}
},
{"query": "/calculateReachableRange/52.36173769505809,4.852169752120972/json?timeBudgetInSec=1800"}
]
}
Calculate Route examples
XML body example
<?xml version="1.0" encoding="utf-8"?>
<batchRequest>
<batchItems>
<batchItem>
<query>/calculateRoute/52.36006039665441,4.851064682006836:52.36187528311709,4.850560426712036/xml?travelMode=car&routeType=fastest&traffic=true&departAt=now&maxAlternatives=0</query>
</batchItem>
<batchItem>
<query>/calculateRoute/52.36241907934766,4.850034713745116:52.36173769505809,4.852169752120972/xml?travelMode=teleport&routeType=fastest&traffic=true&departAt=now</query>
</batchItem>
<batchItem>
<query>/calculateRoute/52.23292,21.06179:43.29379,17.01963/xml</query>
<post>
<postData>
<avoidVignette>
AUS,CHE
</avoidVignette>
</postData>
</post>
</batchItem>
</batchItems>
</batchRequest>
JSON body example
{
"batchItems": [
{"query": "/calculateRoute/52.36006039665441,4.851064682006836:52.36187528311709,4.850560426712036/json?travelMode=car&routeType=fastest&traffic=true&departAt=now&maxAlternatives=0"},
{"query": "/calculateRoute/52.36241907934766,4.850034713745116:52.36173769505809,4.852169752120972/json?travelMode=teleport&routeType=fastest&traffic=true&departAt=now"},
{
"query": "/calculateRoute/52.23292,21.06179:43.29379,17.01963/json",
"post": {
"avoidVignette": [
"AUS",
"CHE"
]
}
}
]
}
Calculate Reachable Range examples
XML body example
<?xml version="1.0" encoding="utf-8"?>
<batchRequest>
<batchItems>
<batchItem>
<query>/calculateReachableRange/52.36187528311709,4.850560426712036/xml?fuelBudgetInLiters=20&constantSpeedConsumptionInLitersPerHundredkm=50,6</query>
<post>
<postData>
<avoidVignette>
NLD
</avoidVignette>
</postData>
</post>
</batchItem>
<batchItem>
<query>/calculateReachableRange/52.36173769505809,4.852169752120972/xml?timeBudgetInSec=1800</query>
</batchItem>
</batchItems>
</batchRequest>
JSON body example
{
"batchItems": [
{
"query": "/calculateReachableRange/52.36187528311709,4.850560426712036/json?fuelBudgetInLiters=20&constantSpeedConsumptionInLitersPerHundredkm=50,6",
"post": {
"avoidVignette": [
"NLD"
]
}
},
{"query": "/calculateReachableRange/52.36173769505809,4.852169752120972/json?timeBudgetInSec=1800"}
]
}
Response data
Batch Submission Response
On a successful Batch Request submission, the Batch Routing service responds with a HTTP 202
or a HTTP 303
. The response has a Location
header with a link to the Batch Download endpoint and no body. In case of an error, a body is present.
HTTP Status codes
Code | Meaning and Possible Causes |
---|---|
202 |
Accepted:
|
303 |
See Other:
|
400 |
Bad Request:
|
403 |
Forbidden:
|
404 |
Not Found: The requested resource could not be found, but it may be available again in the future. |
405 |
Method Not Allowed: The client used a HTTP method other than POST. |
414 |
Requested URI is too long: Indicates that the URI requested by the client is longer than the server is willing to interpret. |
429 |
Too Many Requests: The API Key is over QPS (Queries per second). |
500 |
An error occurred while processing the request. Please try again later. |
502 |
Internal network connectivity issue. Please try again later. |
503 |
Service currently unavailable. Please try again later. |
504 |
Internal network connectivity issue, or a request that has taken too long to complete. Please try again later. |
596 |
Service not found. Request contains an incorrect FQDN and/or path. |
HTTP Response headers
The following table describes HTTP Response headers of particular interest to Batch service clients.
Header | Description |
---|---|
Access-Control-Expose-Headers |
A comma separated list of HTTP header names that browsers are allowed to access. Value: Content-Length |
Access-Control-Allow-Origin |
A header instructing browsers to allow customer websites to contact the Batch Routing service. Value: * |
Content-Encoding |
The Batch Routing service applies gzip compression to the Responses if it is requested by the client with the Accept-Encoding header.Value: gzip |
Content-Type |
The format of the Response as chosen by the client (see the contentType Request parameter).Values:
|
Location |
Indicates the location where the batch results can be downloaded. Value: URI |
Tracking-ID |
An identifier for the Request.
Value: |
Error Response
The error Response content type depends on the outputFormat
parameter.
Error Response example (XML)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<batchResponse xmlns="http://api.tomtom.com/batch" formatVersion="0.0.1">
<error description="Validation of batch item 1 failed. Batch response format (XML) does not match content type of batch item query."/>
<detailedError>
<code>BadRequest</code>
<message>Bad Request</message>
<details>
<detail>
<code>MalformedBody</code>
<message>Validation of batch item 1 failed. Batch response format (XML) does not match content type of batch item query.</message>
<target>postBody</target>
</detail>
</details>
</detailedError>
</batchResponse>
Error Response example (JSON)
{
"formatVersion": "0.0.1",
"error": {
"description": "Validation of batch item 1 failed. Batch response format (JSON) does not match content type of batch item query."
},
"detailedError": {
"code": "BadRequest",
"message": "Bad Request",
"details": {
"code": "MalformedBody",
"message": "Validation of batch item 1 failed. Batch response format (JSON) does not match content type of batch item query",
"target": "postBody",
}
}
}
Error Response fields
Primary fields | |
---|---|
Field | Description |
formatVersion string |
Version of the batch error Response format. |
error object |
Simplified information about the error.error{} object
|
detailedError object |
Detailed information about the error.detailedError{} object
|
error{} object |
|
Field | Description |
description string |
A human-readable description of the error. It is intended as an aid to developers and is not suitable for exposure to end users. |
detailedError{} object |
|
Field | Description |
code string |
One of the defined error codes. |
message string |
A human-readable description of the error code. It is intended as an aid to developers and is not suitable for exposure to end users. |
target string |
Optional. Target of the particular error. Values:
|
details array |
Optional. An array of root causes (more detailed errors) that led to this error. detailedError[] array
|
innerError object |
Optional. A higher level of details about this error. innerError{} object
|
innerError{} object |
|
Field | Description |
code string |
One of the defined error codes. |
message string |
Optional. A human-readable representation of the error code. It is intended as an aid to developers and is not suitable for exposure to end users. |
innerError object |
Optional. A higher level of details about this error. innerError{} object
|
Error code hierarchy
List of predefined, hierarchical, human-readable error codes.
- Top level codes relate to HTTP error codes.
- They may be refined by error codes in
details
orinnerError
. - Further levels of refinement are possible by nesting
innerError
insideinnerError
.
In the future, the list may be extended with additional codes.
The application must be ready for the occurrence of an unknown error code (e.g., by stopping error processing at the last understood level of detail).
Error code | Description |
---|---|
BadArgument |
One of the request parameters was missing or did not pass validation. Possible inner errors:
|
BadRequest |
Top level code for Requests which ended with HTTP Possible root causes:
|
IllegalParameter |
Unsupported request parameter was specified. |
InvalidParameterValue |
The value of one of the parameters is invalid. |
InternalServerError |
Top level code for Requests which ended with HTTP 500 Internal Server Error .The service cannot handle the request right now, an unexpected condition was encountered. |
MalformedBody |
POST body has unexpected format. |
MissingRequiredParameter |
One of the required parameters was not provided. |
NotFound |
Top level code for Requests which ended with HTTP 404 Not Found caused by providing incorrect Request path. |
ServiceUnavailable |
Top level code for Requests which ended with HTTP 503 Service Unavailable .The service cannot handle the request right now, this is certainly a temporary state. |
ValueOutOfRange |
The value of one of the numeric parameters is out of the allowed range. |