Навигация | Truck Directions API | Справочник API | 2GIS Documentation
Truck Directions APIdeprecated
Карты
Поиск
Навигация
2ГИС Про
2ГИС Линза
Личный кабинет
On‑Premise
ру
en

POST /truck/6.0.1/global

Спецификация OpenAPI

Documentation Powered by ReDoc

2GIS Navigation API (6.0.0)

Построение маршрута на грузовом автомобиле

Построение маршрута для грузового транспорта.

query Parameters
key
required
string

API-ключ разработчика

Request Body schema: */*

Параметры запроса

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

Дата и время, на которые производится расчёт маршрута. Указывается как Unix-время.

integer or null
Default: 1

Количество альтернативных маршрутов, которые будут построены в дополнение к основному.

Locale (string) or null
string or null

Название начальной точки

string or null

Название конечной точки

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

Если true, при построении маршрута могут использоваться перекрытые дороги.

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

Набор исключаемых областей, которые следует избегать при построении маршрута. Не более 25.

boolean or null

Если true, то будет построен маршрут внутри зданий (для пешеходных маршрутов).

boolean or null

Если true, в ответ будет добавлена информация о высоте маршрута.

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

Ограничение средней скорости движения км/ч.

TruckParams (object) or null
Array of integers or null

Идентификаторы пропуска в пропускную зону (массив чисел).

Responses

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

Тип ответа:

  • result - Успешный результат,
  • error - Ошибка,

required
object (schemas)

Запрос DirectionsAPI для грузовой маршрутизации.

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

Статус обработки запроса:

  • OK - маршрут построен успешно,
  • FAIL - неизвестная ошибка построения маршрута,
  • POINT_EXCLUDED - точки попали в зону исключения,
  • ROUTE_NOT_FOUND - маршрут не удалось построить на текущих данных дорожного графа,
  • ROUTE_DOES_NOT_EXISTS - маршрут между точками на дорожном графе не существует,
  • ATTRACT_FAIL - не удалось притянуть точки к дорожному графу: одна из точек маршрута удалена от дорожного графа более, чем на 10 км,

required
Array of objects (TruckResultItem)
string or null

Сообщение об ошибке

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
          }
        ]
      }
    ]
}