Sorry, you need to enable JavaScript to visit this website.

Synchronous Matrix

 

Service version: 1
Last edit: 2019.11.08

On this page

Purpose

This endpoint allows the submission of a new matrix for synchronous processing. It responds with a matrix processing result or a HTTP 408 Request timeout error, if the processing time exceeds 60 seconds.

Request data

HTTPS method: POST

URL example

For ease of viewing and identification:

  • Required constants and parameters are shown in bold text.
  • Optional parameters are shown in normal text.
https://baseURL/routing/versionNumber/matrix/sync/outputFormat?key=Your_API_Key&routingOption1=routingValue1&routingOption2=routingValue2...

Example

https://api.tomtom.com/routing/1/matrix/sync/json?key=Your_API_Key&routeType=fastest&travelMode=car

HTTP Request headers

The following table describes HTTP Request headers of particular interest to Matrix Routing service clients.

Required headers
Header Description
Content-Type
string
Specifies the MIME type of the body of the Request.
Values:

  • application/xml
  • application/json
Optional headers
Header Description
Accept-Encoding
string
Should contain list of encodings acceptable by the client. Usually used to demand a compressed Response.
Value: gzip
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.
Value: It may be:

  • json
  • xml
routingOption
object
A set of routing options encapsulating parameters modifying a route calculation behaviour.

  • This can be specified multiple times.
  • It represents a supported parameter of the Routing service.
  • Please note: Parameters that are not supported are:
    • locations
    • maxAlternatives
    • instructionsType
    • language
    • computeBestOrder
    • routeRepresentation
    • vehicleHeading
    • report
    • callback
    • minDeviationTime
    • minDeviationDistance
    • alternativeType
  • Routing's POST data parameters may be delivered using the post field. For details, please check the Matrix Routing POST body definition.

Value: string

▲ Return to top

POST body

The POST body of a Matrix Request should contain a set of items which will be used to execute Requests to the Routing service. The maximum size of a matrix for this API is 100 (the number of origins multiplied by the number of destinations), so examples of matrix dimensions are: 5x10, 10x10(it does not need to be square).

POST body (XML)

<?xml version="1.0" encoding="utf-8"?>
<matrixRequest>
  <origins>
    <location><point latitude="latitudeValue" longitude="longitudeValue"/></location>
    ...
    <location><point latitude="latitudeValue" longitude="longitudeValue"/></location>
  </origins>

  <destinations>
    <location><point latitude="latitudeValue" longitude="longitudeValue"/></location>
    ...
    <location><point latitude="latitudeValue" longitude="longitudeValue"/></location>
  </destinations>

  <options>
    <post>...</post>
  </options>
</matrixRequest>

POST body (JSON)

{
  "origins": [
    {
      "point": {"latitude": latitudeValue,"longitude": longitudeValue}
    },
    ...
    {
      "point": {"latitude": latitudeValue,"longitude": longitudeValue}
    }
  ],

  "destinations": [
    {
      "point": {"latitude": latitudeValue,"longitude": longitudeValue}
    },
    ...
    {
      "point": {"latitude": latitudeValue,"longitude": longitudeValue}
    }
  ],

  "options": {
    "post": "...":
  }
}

▲ Return to top

POST body fields

Required fields
Field Description
matrixRequest The XML root element of the Request.
origins A set of origin locations represented by points (lat,lon). At least one origin is required.
destinations A set of destination locations represented by points (lat,lon). At least one destination is required.
Optional fields
Field Description
options A set of options.
post Contains data that is passed to the Calculate Route service using the HTTP POST method.

  • The POST data format must match the Content-Type header of a submitted matrix Request i.e., it should be in the JSON format when the Content-Type is set to application/json and should be in the XML format if Content-Type is set to application/xml.
  • Otherwise, the data will not be interpreted correctly, and all Matrix elements will end with response code 400.
  • Please refer to the POST Data parameters section of Calculate Route service documentation for detailed descriptions and examples of XML and JSON content for this field.

▲ Return to top

POST body examples

XML POST body example

<?xml version="1.0" encoding="utf-8"?>
<matrixRequest>
  <origins>
    <location><point latitude="45.458545" longitude="9.150490"/></location>
    <location><point latitude="45.403337" longitude="11.050541"/></location>
  </origins>

  <destinations>
    <location><point latitude="48.149853" longitude="11.499931"/></location>
    <location><point latitude="50.033688" longitude="14.538226"/></location>
  </destinations>

  <options>
    <post>
      <postData>
        <avoidVignette>
          AUS,CHE
        </avoidVignette>
      </postData>
    </post>
  </options>
</matrixRequest>

JSON POST body example

{
  "origins": [
    {
      "point": {"latitude": 45.458545,"longitude": 9.150490}
    },
    {
      "point": {"latitude": 45.403337,"longitude": 11.050541}
    }
  ],

  "destinations": [
    {
      "point": {"latitude": 48.149853,"longitude": 11.499931}
    },
    {
      "point": {"latitude": 50.033688,"longitude": 14.538226}
    }
  ],

  "options": {
    "post": {
      "avoidVignette": [
        "AUS",
        "CHE"
      ]
    }
  }
}

▲ Return to top

Response data

HTTP Status codes

Code Meaning and Possible Causes
200 OK: The matrix calculation has completed. Results are streamed to the client.
400 Bad Request: Missing required parameters, parameters did not pass validation, or the matrix size is too large.
403 Forbidden:

  • The API Key is missing, inactive, invalid, not entitled to use Matrix 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.
408 Request timeout: The request sent to the server took longer than it was prepared to wait.
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 lists HTTP Response headers of particular interest to Routing 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 Matrix Routing service.
Value: *
Content-Encoding The Matrix 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 matrix 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.

▲ Return to top

Successful Response examples

Click to expand/collapse the following examples

XML example

<?xml version="1.0" encoding="UTF-8"?>
<matrixResponse
  xmlns="http://api.tomtom.com/matrix" formatVersion="0.0.1">
  <matrix>
    <row>
      <cell>
        <statusCode>200</statusCode>
        <response>
          <routeSummary>
            <lengthInMeters>543514</lengthInMeters>
            <travelTimeInSeconds>21506</travelTimeInSeconds>
            <trafficDelayInSeconds>46</trafficDelayInSeconds>
            <departureTime>2018-08-10T10:17:49+02:00</departureTime>
            <arrivalTime>2018-08-10T16:16:14+02:00</arrivalTime>
            <noTrafficTravelTimeInSeconds>19477</noTrafficTravelTimeInSeconds>
            <historicTrafficTravelTimeInSeconds>21463</historicTrafficTravelTimeInSeconds>
            <liveTrafficIncidentsTravelTimeInSeconds>21506</liveTrafficIncidentsTravelTimeInSeconds>
          </routeSummary>
        </response>
      </cell>
      <cell>
        <statusCode>400</statusCode>
        <response>Engine error while executing route request: MAP_MATCHING_FAILURE</response>
      </cell>
    </row>
    <row>
      <cell>
        <statusCode>200</statusCode>
        <response>
          <routeSummary>
            <lengthInMeters>423638</lengthInMeters>
            <travelTimeInSeconds>16161</travelTimeInSeconds>
            <trafficDelayInSeconds>46</trafficDelayInSeconds>
            <departureTime>2018-08-10T10:17:49+02:00</departureTime>
            <arrivalTime>2018-08-10T14:47:09+02:00</arrivalTime>
            <noTrafficTravelTimeInSeconds>15072</noTrafficTravelTimeInSeconds>
            <historicTrafficTravelTimeInSeconds>16119</historicTrafficTravelTimeInSeconds>
            <liveTrafficIncidentsTravelTimeInSeconds>16161</liveTrafficIncidentsTravelTimeInSeconds>
          </routeSummary>
        </response>
      </cell>
      <cell>
        <statusCode>200</statusCode>
        <response>
          <routeSummary>
            <lengthInMeters>836087</lengthInMeters>
            <travelTimeInSeconds>29608</travelTimeInSeconds>
            <trafficDelayInSeconds>181</trafficDelayInSeconds>
            <departureTime>2018-08-10T10:17:49+02:00</departureTime>
            <arrivalTime>2018-08-10T18:31:16+02:00</arrivalTime>
            <noTrafficTravelTimeInSeconds>26776</noTrafficTravelTimeInSeconds>
            <historicTrafficTravelTimeInSeconds>29447</historicTrafficTravelTimeInSeconds>
            <liveTrafficIncidentsTravelTimeInSeconds>29608</liveTrafficIncidentsTravelTimeInSeconds>
          </routeSummary>
        </response>
      </cell>
    </row>
  </matrix>
  <summary>
    <successfulRoutes>3</successfulRoutes>
    <totalRoutes>4</totalRoutes>
  </summary>
</matrixResponse>

JSON example

{
  "formatVersion": "0.0.1",
  "matrix": [
    [
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 495,
            "travelTimeInSeconds": 135,
            "trafficDelayInSeconds": 0,
            "departureTime": "2018-08-10T10:20:42+02:00",
            "arrivalTime": "2018-08-10T10:22:56+02:00",
            "noTrafficTravelTimeInSeconds": 134,
            "historicTrafficTravelTimeInSeconds": 135,
            "liveTrafficIncidentsTravelTimeInSeconds": 135
          }
        }
      },
      {
        "statusCode": 400,
        "response": "Engine error while executing route request: MAP_MATCHING_FAILURE"
      }
    ],
    [
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 338,
            "travelTimeInSeconds": 105,
            "trafficDelayInSeconds": 0,
            "departureTime": "2018-08-10T10:20:42+02:00",
            "arrivalTime": "2018-08-10T10:22:27+02:00",
            "noTrafficTravelTimeInSeconds": 104,
            "historicTrafficTravelTimeInSeconds": 105,
            "liveTrafficIncidentsTravelTimeInSeconds": 105
          }
        }
      },
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 681999,
            "travelTimeInSeconds": 25106,
            "trafficDelayInSeconds": 1769,
            "departureTime": "2018-08-10T10:20:42+02:00",
            "arrivalTime": "2018-08-10T17:19:07+02:00",
            "noTrafficTravelTimeInSeconds": 21031,
            "historicTrafficTravelTimeInSeconds": 23569,
            "liveTrafficIncidentsTravelTimeInSeconds": 25106
          }
        }
      }
    ]
  ],
  "summary": {
    "successfulRoutes": 3,
    "totalRoutes": 4
  }
}

▲ Return to top

Successful Response fields

Field Description
matrixResponse The XML root element of the Matrix Response.
matrix A set of rows containing results of route summary calculations.
row Every row represents a set of results of route summary calculations done for a single origin.
cell A single result of route summary calculation.
statusCode The status code of a Response for a route summary calculation.
response Contains a result of the route summary calculation or an error message.
detailedError Contains detailed information about route summary calculation failure (if available in the route summary calculation error response).
routeSummary Contains a result of the route summary calculation.
lengthInMeters Element of routeSummary. The route length in meters.
trafficDelayInSeconds Element of routeSummary. The delay in seconds compared to free-flow conditions according to real-time traffic information.
departureTime Element of routeSummary. The estimated departure time for the route. Specified as a dateTime.
arrivalTime Element of routeSummary. The estimated arrival time for the route. Specified as a dateTime.
travelTimeInSeconds Element of routeSummary. The estimated travel time in seconds. Note that even when traffic=false, travelTimeInSeconds still includes the delay due to traffic.
noTrafficTravelTimeInSeconds Element of routeSummary. The estimated travel time in seconds calculated as if there are no delays on the route due to traffic conditions (e.g., congestion). It will only be present if the routing option computeTravelTimeFor=all will be passed in the Request.
historicTrafficTravelTimeInSeconds Element of routeSummary. The estimated travel time in seconds calculated using time-dependent historic traffic data. It will only be present if the routing option computeTravelTimeFor=all will be passed in the Request.
liveTrafficIncidentsTravelTimeInSeconds Element of routeSummary. The estimated travel time in seconds calculated using real-time speed data. It will only be present if the routing option computeTravelTimeFor=all will be passed in the Request.
summary The summary of the matrix Request.
successfulRoutes The number of successful route calculation Requests.
totalRoutes The total number of processed route calculation Requests.

▲ Return to top

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"?>
<matrixResponse xmlns="http://api.tomtom.com/matrix" formatVersion="0.0.1">
  <error description="Parameter redirectMode: mistake is unsupported."/>
  <detailedError>
    <code>BadRequest</code>
    <message>Bad Request</message>
    <details>
      <detail>
        <code>BadArgument</code>
        <message>Parameter redirectMode: mistake is unsupported.</message>
        <target>redirectMode</target>
        <innerError>
          <code>InvalidParameterValue</code>
        </detail>
      </detail>
    </details>
  </detailedError>
</matrixResponse>

Error Response example (JSON)

{
  "formatVersion":"0.0.1",
  "error":{
    "description":"Parameter redirectMode: mistake is unsupported."
  },
  "detailedError":{
    "code":"BadRequest",
    "message":"Bad Request",
    "details":[
      {
        "code":"BadArgument",
        "message":"Parameter redirectMode: mistake is unsupported.",
        "target":"redirectMode",
        "innerError":{
          "code":"InvalidParameterValue"
        }
      }
    ]
  }
}

▲ Return to top

Error Response fields

Primary fields
Field Description
formatVersion
string
Version of the matrix 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
BadRequest

Top level code for Requests which ended with 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 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.
MatrixCellError This code may appear inside detailedError object in case of a successfully completed Matrix calculation with failed cell(s), which are not valid
Calculate Route service error responses.
MatrixRequestTimeout Top level code for Requests which ended with HTTP 408 Request Timeout.
Calculating matrix takes too long to complete using sync mode. Please recalculate using async mode.
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.

▲ Return to top

You are here