Navigation | Truck Directions API | API Reference | 2GIS Documentation
Truck Directions APIdeprecated
Maps
Search
Navigation
Urbi Pro
CityLens
Account
On‑Premise

POST /truck/6.0.1/global

OpenAPI Specification

Documentation Powered by ReDoc

2GIS Navigation API (6.0.0)

Building a route for a truck

Truck Directions API allows you to build a truck route.

query Parameters
key
required
string

Developer API key

Request Body schema: */*

Request parameters

required
Array of objects (RequestPoint)
integer or null <long>

Date and time to use instead of the current date and time. Specified as Unix time.

integer or null
Default: 1

Number of alternative routes to be built in addition to the main route

Locale (string) or null
string or null

Start point name

string or null

End point name

TruckRequestType (string) or null
Array of RequestOption (strings) or RequestOption (string) or null
Array of RequestFilter (strings) or RequestFilter (string) or null
boolean or null

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

OutputType (string) or null
Array of objects (ExcludeObject)

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

boolean or null

If true, an indoor route will be included in the result (for pedestrian routes).

boolean or null

If true, altitude information will be included in the response.

Array of HardFilter (strings) or HardFilter (string) or null
number or null

Average speed limit, km/h

TruckParams (object) or null
Array of integers or null

Identifier of a pass for a zone (array of numbers).

Responses

Response Schema: application/json
type
required
string (schemas)
Enum: "result" "error"

Response type:

  • result - Success result,
  • error - Error,

required
object (schemas)

Truck DirectionsAPI query.

status
required
string (schemas)
Enum: "OK" "FAIL" "POINT_EXCLUDED" "ROUTE_NOT_FOUND" "ROUTE_DOES_NOT_EXISTS" "ATTRACT_FAIL"

Request status:

  • OK - route was successfully calculated,
  • FAIL - an unknown error occurred when calculating the route,
  • POINT_EXCLUDED - one of the points was excluded by the excluded objects,
  • ROUTE_NOT_FOUND - the route could not be build on the current data of the road graph,
  • ROUTE_DOES_NOT_EXISTS - the route between points on the road graph doesn't exist,
  • ATTRACT_FAIL - an error occurred while attracting the points: one of the points is more than 10 km away from the road graph,

required
Array of objects (TruckResultItem)
string or null

Error message

Response samples

Content type
application/json
{
  • "type": "result",
  • "query": {
    • "alternative": 0,
    • "exclude": [
      • {
        • "extent": 100,
        • "points": [
          • {
            }
          ],
        • "severity": "hard",
        • "type": "point"
        },
      • {
        • "extent": 1000,
        • "points": [
          • {
            },
          • {
            }
          ],
        • "severity": "soft",
        • "type": "polyline"
        }
      ],
    • "locale": "ru",
    • "need_altitudes": true,
    • "point_a_name": "Source",
    • "point_b_name": "Target",
    • "points": [
      • {
        • "start": true,
        • "type": "walking",
        • "x": 82.93057,
        • "y": 54.943207
        },
      • {
        • "object_id": "141476222741292",
        • "start": false,
        • "type": "walking",
        • "x": 82.945039,
        • "y": 55.033879
        }
      ],
    • "type": "jam"
    },
  • "message": "string",
  • "status": "OK",
  • "result": [
    • {
      • "algorithm": "с учётом пробок",
      • "altitudes_info": {
        • "elevation_gain": 10690,
        • "elevation_loss": 9570,
        • "max_altitude": 10900,
        • "max_road_angle": 4,
        • "min_altitude": 7100
        },
      • "begin_pedestrian_path": {
        • "geometry": {
          • "selection": "LINESTRING(82.930569 54.943206, 82.930674 54.943273, 82.930683 54.943330, 82.930723 54.943655)"
          }
        },
      • "end_pedestrian_path": {
        • "geometry": {
          • "selection": "LINESTRING(82.945324 55.033714, 82.945039 55.033878)"
          }
        },
      • "filter_road_types": [
        • "dirt_road",
        • "highway"
        ],
      • "id": "7669814625906049348",
      • "maneuvers": [
        • {
          • "comment": "Source",
          • "icon": "start",
          • "id": "18243427438627852119",
          • "outcoming_path": {
            },
          • "outcoming_path_comment": "10 м прямо",
          • "type": "begin"
          },
        • {
          • "comment": "Поворот направо на ул. Петухова",
          • "icon": "crossroad_right",
          • "id": "11013427180351570021",
          • "outcoming_path": {
            },
          • "outcoming_path_comment": "400 м прямо",
          • "turn_angle": 90,
          • "turn_direction": "right",
          • "type": "crossroad"
          },
        • {
          • "comment": "Поворот направо на ул. Петухова",
          • "icon": "crossroad_right",
          • "id": "10486992078115446896",
          • "outcoming_path": {
            },
          • "outcoming_path_comment": "2 км прямо",
          • "turn_angle": 90,
          • "turn_direction": "right",
          • "type": "crossroad"
          },
        • {
          • "comment": "Круговое движение 1 съезд на ул. Сибиряков-Гвардейцев",
          • "icon": "ringroad_right_90",
          • "id": "851511220966961902",
          • "outcoming_path": {
            },
          • "outcoming_path_comment": "50 м прямо",
          • "ringroad_exit_number": 1,
          • "turn_angle": 85,
          • "type": "ringroad"
          },
        • {
          • "comment": "1 съезд на ул. Сибиряков-Гвардейцев",
          • "icon": "ringroad_exit",
          • "id": "14676290839728035649",
          • "outcoming_path": {
            },
          • "outcoming_path_comment": "3.4 км прямо",
          • "type": "ringroad_exit"
          },
        • {
          • "comment": "Поворот направо на ул. Немировича-Данченко",
          • "icon": "crossroad_right",
          • "id": "11682105410583176895",
          • "outcoming_path": {
            },
          • "outcoming_path_comment": "5.1 км прямо",
          • "turn_angle": 100,
          • "turn_direction": "right",
          • "type": "crossroad"
          },
        • {
          • "comment": "Плавный поворот направо на ул. Большевистская",
          • "icon": "crossroad_slightly_right",
          • "id": "3887500705741526467",
          • "outcoming_path": {
            },
          • "outcoming_path_comment": "350 м прямо",
          • "turn_angle": 13,
          • "turn_direction": "slightly_right",
          • "type": "crossroad"
          },
        • {
          • "comment": "Крутой поворот направо на ул. Большевистская",
          • "icon": "crossroad_sharply_right",
          • "id": "17324583098489101207",
          • "outcoming_path": {
            },
          • "outcoming_path_comment": "900 м прямо",
          • "turn_angle": 158,
          • "turn_direction": "sharply_right",
          • "type": "crossroad"
          },
        • {
          • "comment": "Держитесь правее",
          • "icon": "crossroad_keep_right",
          • "id": "2357458904113779569",
          • "outcoming_path": {
            },
          • "outcoming_path_comment": "200 м прямо",
          • "turn_angle": 2,
          • "turn_direction": "keep_right",
          • "type": "crossroad"
          },
        • {
          • "comment": "Круговое движение 1 съезд на ул. Ипподромская",
          • "icon": "ringroad_right_45",
          • "id": "3505931146236764371",
          • "outcoming_path": {
            },
          • "outcoming_path_comment": "20 м прямо",
          • "ringroad_exit_number": 1,
          • "turn_angle": 48,
          • "type": "ringroad"
          },
        • {
          • "comment": "1 съезд на ул. Ипподромская",
          • "icon": "ringroad_exit",
          • "id": "8473919833578789823",
          • "outcoming_path": {
            },
          • "outcoming_path_comment": "2.4 км прямо",
          • "type": "ringroad_exit"
          },
        • {
          • "comment": "Поворот направо на ул. Ядринцевский Конный спуск",
          • "icon": "crossroad_right",
          • "id": "9217065371019675846",
          • "outcoming_path": {
            },
          • "outcoming_path_comment": "250 м прямо",
          • "turn_angle": 47,
          • "turn_direction": "right",
          • "type": "crossroad"
          },
        • {
          • "comment": "Поворот направо на ул. Ядринцевский Конный спуск",
          • "icon": "crossroad_right",
          • "id": "7594775025999479592",
          • "outcoming_path": {
            },
          • "outcoming_path_comment": "100 м прямо",
          • "turn_angle": 101,
          • "turn_direction": "right",
          • "type": "crossroad"
          },
        • {
          • "comment": "Крутой поворот налево на ул. Военная Горка 5-я линия",
          • "icon": "crossroad_sharply_left",
          • "id": "18286432877377999606",
          • "outcoming_path": {
            },
          • "outcoming_path_comment": "100 м прямо",
          • "turn_angle": -117,
          • "turn_direction": "sharply_left",
          • "type": "crossroad"
          },
        • {
          • "comment": "Поворот направо на ул. Военная Горка 5-я линия",
          • "icon": "crossroad_right",
          • "id": "7570173330757430500",
          • "outcoming_path": {
            },
          • "outcoming_path_comment": "30 м прямо",
          • "turn_angle": 48,
          • "turn_direction": "right",
          • "type": "crossroad"
          },
        • {
          • "comment": "Target",
          • "icon": "finish",
          • "id": "13991250694901917865",
          • "outcoming_path_comment": "Вы на месте!",
          • "type": "end"
          }
        ],
      • "reliability": 1,
      • "route_id": "m1api.m1/carrouting/1655371727.777",
      • "total_distance": 15186,
      • "total_duration": 2822,
      • "type": "carrouting",
      • "ui_total_distance": {
        • "unit": "км",
        • "value": "15"
        },
      • "ui_total_duration": "47 мин",
      • "waypoints": [
        • {
          • "original_point": {
            },
          • "projected_point": {
            },
          • "transit": false
          },
        • {
          • "original_point": {
            },
          • "projected_point": {
            },
          • "transit": false
          }
        ]
      }
    ]
}