Перейти к основному содержимому

POST /carrouting/6.0.1/global

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

2GIS Navigation API (6.0.0)

Маршрут на автомобиле

Построение маршрута на автомобиле и пешком

Построение маршрута из нескольких точек для разного типа транспорта.

query Parameters
key
required
string

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

Request Body schema: */*
required

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

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

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

RequestType (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

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

boolean or null

Обогащает ответ информацией о покраске ребер

Responses

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

Тип ответа:

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

required
object (DirectionsRequestModel)

Запрос DirectionsAPI.

string or null

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

status
required
string (StatusType)
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 (ResultItem)

Response samples

Content type
application/json
{
  • "type": "result",
  • "query": {
    • "alternative": 0,
    • "exclude": [
      ],
    • "locale": "ru",
    • "need_altitudes": true,
    • "point_a_name": "Source",
    • "point_b_name": "Target",
    • "points": [
      ],
    • "type": "jam"
    },
  • "message": "string",
  • "status": "OK",
  • "result": [
    • {
      }
    ]
}