If true, the route may include driving on closed roads.

If true, the route may include detailed information.

An array of areas to avoid when building a route. Not more than 25 areas.

Which points from the `points` array are starting points (array of indexes).

Date and time to use instead of the current date and time. Specified in <a href='https://tools.ietf.org/html/rfc3339#section-5.8' target='_blank'>RFC 3339</a> format (e.g., <i>2020-05-15T15:52:01Z</i>).

Which points from the `points` array are end points (array of indexes).

The result of building the adjacency matrix

An array of found routes. For each successive pair of points, there is exactly one route.Thus, in the case of P-P, there will be one route here, but in general there will be N-1 routes for N points.

Task status for building the adjacency matrix

Additional information about the task status

Radius in meters around the specified coordinates to be avoided.

How strictly to avoid the area: <ul type="disk"> <li>soft - weak exclusion, try to avoid the area, </li><li>hard - strong exclusion, always avoid the area, </li></ul>

Shape of the area: <ul type="disk"> <li>point -  a circle with a radius equal to `extent` (`points` is the center of the circle), </li><li>polyline - a line with a width equal to `extent` (`points` are the vertices of the line), </li><li>polygon - a polygon (`points` are the vertices of the polygon), </li></ul>

Point type: <ul type="disk"> <li>stop - start or end point of the route (with a straight path to a road), </li><li>walking - start or end point of the route (with a pedestrian path to a road), </li></ul>

Roads to avoid when building a route: <ul type="disk"> <li>dirt_road - avoid dirt roads when building a car or pedestrian route, </li><li>toll_road - avoid toll roads when building a car route, </li><li>ferry - avoid ferries when building a car or pedestrian route, </li><li>highway - avoid highways when building a pedestrian route, </li><li>ban_car_road - avoid car roads when building a bicycle route, </li><li>ban_stairway - avoid stairways when building a bicycle route, </li><li>ban_over - avoid overground crossings and underground crossings when building a bicycle route, </li></ul>

Routing type: <ul type="disk"> <li>driving - car route, </li><li>taxi - car route (including public transport lanes), </li><li>truck - car route (including public transport lanes), </li><li>walking - pedestrian route, </li><li>bicycle - bicycle route, </li></ul>

Distance from the point in meters on which the direction of movement must be maintained. Starting point only.

Route type: <ul type="disk"> <li>jam - shortest route in time using current traffic data, </li><li>statistics - shortest route in time using statistical traffic data, </li><li>shortest - shortest route in distance, </li></ul>

Response type: <ul type="disk"> <li>result - Success result, </li><li>error - Error, </li></ul>

If true, the route includes closed roads.

Accuracy of the route as a number from 0 to 1 (if `distance_direction` was set)

Index of the starting point (from the `points` array)

Index of the end point (from the `points` array)

Request status: <ul type="disk"> <li>FAIL - an unknown error occurred when calculating the route, </li><li>OK - route was successfully built, </li><li>POINT_EXCLUDED - one of the points was excluded by the excluded objects, </li><li>ROUTE_NOT_FOUND - the route could not be build on the current data of the road graph, </li><li>ROUTE_DOES_NOT_EXISTS - the route between points on the road graph doesn't exist, </li><li>ATTRACT_FAIL - an error occurred while attracting the points: one of the points is more than 10 km away from the road graph, </li></ul>

Task status: <ul type="disk"> <li>TASK_CREATED - task has been created, </li><li>TASK_IN_PROGRESS - task is being processed, </li><li>TASK_DONE - task was completed, </li><li>TASK_IN_QUEUE - task is in a queue, waiting to be processed, </li><li>TASK_CANCELED - task was cancelled, </li></ul>

2GIS Navigation API

Creating a task to get information about travel distance and time between points

version

Response format: <ul type="disk"> <li> `protobuf` - Protocol Buffer <a href="http://disk.2gis.com/navi-docs/DistanceMatrix.proto">DistanceMatrix.proto</a> </li><li> `json` - json format</li></ul>

response_format

task_id

Getting information about travel distance and time between points.

Array of calculated routes (distances and durations)

The request execution time has exceeded 5 seconds

Distance Matrix API