Asynchronous Batch Submission

Service version: 1

Last edit: 2022.10.01

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`

Constants and parameters enclosed in curly brackets &#123 } 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.

URL request format

https://{baseURL}/routing/{versionNumber}/batch/json?key={Your_API_Key}&redirectMode={redirectMode}&waitTimeSeconds={waitTimeSeconds}

URL request example

https://api.tomtom.com/routing/1/batch/json?key={Your_API_Key}

curl request example

curl -XPOST 'https://api.tomtom.com/routing/1/batch/json?key={Your_API_Key}'

Request headers

The following data table describes HTTP request headers of particular interest to Batch service clients.

Required headers	Description
Content-Type	Specifies the MIME type of the body of the request. It may be: `application/json`

Required headers

Description

Content-Type

Specifies the MIME type of the body of the request. It may be:

application/json

Optional headers	Description
Tracking-ID	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.

Optional headers

Description

Tracking-ID

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.

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	Description
`baseURL` string	Base URL for calling the API. Values: `api.tomtom.com`: The default global API endpoint. `kr-api.tomtom.com`: The region-specific endpoint for South Korea. See the region-specific content documentation
`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`.

Required parameters

Description

baseURL
string

Base URL for calling the API.

Values:

api.tomtom.com: The default global API endpoint.
kr-api.tomtom.com: The region-specific endpoint for South Korea. See the
region-specific content documentation

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	Description
`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 the 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`

Optional parameters

Description

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 the provided waitTimeSecondsparameter 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

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 request 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.

1{
"batchItems": [
  {"query": "..."},
  ...
  {
    "query": "...",
    "post": {...}
  }
]
10}

POST request body fields

Field	Description
`batchItems`	A set of batch items. Value: The maximum number of batch items for an Asynchronous API is `700`.
`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 be `json`. The query string values must be properly escaped (e.g., a " character should be escaped with a \ (backslash)). More information is available in RFC 7159 . 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`. Please refer to the POST Data parameters section of Calculate Route and Calculate Reachable Range services documentation for detailed descriptions and examples of content for this field.

Field

Description

batchItems

A set of batch items.

Value: The maximum number of batch items for an Asynchronous API is 700.

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 be json.
The query string values must be properly escaped (e.g., a " character should be escaped with a \ (backslash)). More information is available in RFC 7159 .
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

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.
Please refer to the POST Data parameters section of
Calculate Route
and
Calculate Reachable Range
services documentation for detailed descriptions and examples of content for this field.

POST request body examples

1{
"batchItems": [
  {
    "query": "/calculateRoute/52.36006039665441,4.851064682006836:52.36187528311709,4.850560426712036/json?travelMode=car&amp;routeType=fastest&amp;traffic=true&amp;departAt=now&amp;maxAlternatives=0"
  },
  {
    "query": "/calculateRoute/52.36241907934766,4.850034713745116:52.36173769505809,4.852169752120972/json?travelMode=teleport&amp;routeType=fastest&amp;traffic=true&amp;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&amp;constantSpeedConsumptionInLitersPerHundredkm=50,6",
    "post": {
      "avoidVignette": [
        "NLD"
      ]
    }
  },
  {
    "query": "/calculateReachableRange/52.36173769505809,4.852169752120972/json?timeBudgetInSec=1800"
  }
]
30}

1{
"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"
      ]
    }
  }
]
19}

1{
"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"
  }
]
15}

Response data

Batch Submission response

On a successful Batch request submission, the Batch Routing service responds with an HTTP 202 or an 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 & possible causes
`202`	Accepted: An 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: An 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 an 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.

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/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

1{
"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"
  }
}
15}

Error response fields

Primary fields	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

Error code hierarchy

A 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 an 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 an 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 an HTTP `404 Not Found` caused by providing incorrect request path.
`ServiceUnavailable`	Top level code for requests which resulted in an 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.

Asynchronous Batch Submission

Purpose

Request data

HTTPS Method: POST

URL request format

URL request example

curl request example

Request headers

Request parameters

Supported Routing API suite endpoints

POST request body

POST request body fields

POST request body examples

Response data

Batch Submission response

HTTP Status codes

Response headers

Error response

Error response fields

Error code hierarchy

HTTPS Method: `POST`