Sorry, you need to enable JavaScript to visit this website.
Market Coverage
Routing API and Extended Routing API
Get your key

Asynchronous Batch Submission

 

Service version: 1
Last edit: 2020.11.29

Deprecation Notice:

Dec 1, 2020:
  • All XML capabilities of the Batch Routing API are deprecated. This includes:
    • base path parameter outputFormat value xml
    • request header Content-Type value application/xml
    • POST body batch item's query output format (last path element) value xml
    • POST body parameter post value format xml
  • These capabilities will be withdrawn following a 12 month deprecation period.
  • The planned withdrawal date is Dec 1, 2021.
  • Following withdrawal, requests using this functionality may receive an HTTP error in the response.

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

▲ Return to top

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:
  • application/xml Deprecated - for details, see a deprecation notice at the top of this page.
  • application/json
Optional headers
Header Description
Tracking-ID
string		 Specifies an identifier for the Request.
  • It can be used to trace a call.
  • The value must match the regular expression '^[a-zA-Z0-9-]{1,100}$'.
  • An example of format that matches this regular expression is UUID: (e.g., 9ac68072-c7a4-11e8-a8d5-f2801f1b9fd1). For details check RFC 4122.
  • If specified, it is replicated in the Tracking-ID Response header.
  • It is only meant to be used for support and does not involve tracking of you or your users in any form.
Value: An identifier for the Request.

▲ Return to top

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:
  • json
  • xml Deprecated - for details, see a deprecation notice at the top of this page.
redirectMode
string		 Controls the HTTP code of the successful HTTP Response to the Submission Request.
Value:
  • When set to auto, HTTP code 303 is returned. The HTTP client may automatically redirect to the download endpoint.
  • When set to manual, HTTP code 202 is returned. The HTTP client will not automatically redirect to the download endpoint.
In both cases the same Location header is included.
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 waitTimeSeconds parameter and its value are passed to the Location response header as a part of the URI.

Default value: 120
Value: It may be either:
  • 5..60
  • 120

▲ Return to top

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.
  • It is a partial URL without protocol, base URL, service version or API Key parts.
  • The output format (last path element) must match the outputFormat parameter of the batch Request.
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 &amp;). More information is available in the List of XML character entity references. Deprecated - for details, see a deprecation notice at the top of this page.

Please note that the callback parameter is not supported by Batch Routing. For detailed descriptions refer to the documentation of Calculate Route and Calculate Reachable Range services.
post Contains data that is passed to the Calculate Route or Calculate Reachable Range services using the HTTP POST method.
  • The POST data format must match the Content-Type header of a submitted batch request i.e., it should be in JSON format when the Content-Type is set to application/json and should be in XML format (Deprecated - for details, see a deprecation notice at the top of this page) if the Content-Type is set to application/xml.
  • Please refer to the POST Data Parameters section of Calculate Route and Calculate Reachable Range services documentation for detailed descriptions and examples of XML and JSON content for this field.

▲ Return to top

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&amp;routeType=fastest&amp;traffic=true&amp;departAt=now&amp;maxAlternatives=0</query>
    </batchItem>
    <batchItem>
      <query>/calculateRoute/52.36241907934766,4.850034713745116:52.36173769505809,4.852169752120972/xml?travelMode=teleport&amp;routeType=fastest&amp;traffic=true&amp;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&amp;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&amp;routeType=fastest&amp;traffic=true&amp;departAt=now&amp;maxAlternatives=0</query>
    </batchItem>
    <batchItem>
      <query>/calculateRoute/52.36241907934766,4.850034713745116:52.36173769505809,4.852169752120972/xml?travelMode=teleport&amp;routeType=fastest&amp;traffic=true&amp;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&amp;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"}
  ]
}

▲ Return to top

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:
  • A HTTP Response with a Location header that points where the batch results can be obtained.
  • This code is used when redirectMode is set to manual.
303 See Other:
  • A HTTP Response with a Location header that points where the batch results can be obtained.
  • This code is used when redirectMode is set to auto.
400 Bad Request:
  • Missing required parameters.
  • Exceeded maximum number of batch items.
  • Parameters did not pass validation.
403 Forbidden:
  • The API Key is missing, inactive, invalid, not entitled to use Batch Routing API over QPS (Queries per second) or over QPD (Queries per day).
  • Can also occur when using HTTP instead of HTTPS.
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.

▲ Return to top

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:
  • application/xml;charset=utf-8
  • application/json;charset=utf-8
Location Indicates the location where the batch results can be downloaded.
Value: URI
Tracking-ID An identifier for the Request.
  • If the Tracking-ID header was specified, it is replicated in the Response.
  • Otherwise, it is generated automatically by the service.
  • It is only meant to be used for support and does not involve tracking of you or your users in any form.
Value: An identifier for the Request.

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",
    }
  }
}

▲ Return to top

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:
  • The name of the Request parameter.
  • postBody
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

▲ Return to top

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 or innerError.
  • Further levels of refinement are possible by nesting innerError inside innerError.

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. The target field contains the name of the related parameter.

Possible inner errors:

  • MissingRequiredParameter
  • InvalidParameterValue
  • IllegalParameter
  • ValueOutOfRange
BadRequest

Top level code for Requests which resulted in a HTTP 400 Bad Request.

Possible root causes:

  • BadArgument
  • MalformedBody
IllegalParameter Unsupported request parameter was specified.
InvalidParameterValue The value of one of the parameters is invalid.
InternalServerError Top level code for Requests which resulted in a 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 resulted in a HTTP 404 Not Found caused by providing incorrect Request path.
ServiceUnavailable Top level code for Requests which resulted in a 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.

▲ Return to top