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

POST /isochrone/2.0.0

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

2GIS Navigation API (6.0.0)

Алгоритмы

Построение достижимой области на карте

Получение области на карте, которая достижима от указанной точки за указанное время пешком, на автомобиле, велосипеде или общественном транспорте.

query Parameters
key
required
string

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

Request Body schema: */*
required

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

durations
required
Array of integers

Массив отрезков времени, за которые нужно добраться до конечной точки.

required
object (WGS84Point)

Координаты точки в формате WGS84.

string or null

Дата и время начала движения в формате RFC 3339 (например, 2020-05-15T15:52:01Z).

boolean or null

Реверсивность движения:

  • false - движение от указанной точки до границ области
  • true - движение от границ области до указанной точки

detailing
number
Default: 0

Уровень детализации многоугольника от 0 до 1, где 0 - минимальная детализация, 1 - максимальная детализация.

transport
string
Default: "driving"
Enum: "driving" "walking" "bicycle" "motorcycle" "public_transport"

Тип движения:

  • driving - автомобильный,
  • walking - пешеходный,
  • bicycle - велосипедный,
  • motorcycle - мотоциклетный,
  • public_transport - на общественном транспорте,

Array of CTXTransportType (strings) or null

Типы общественного транспорта.

ResponseGeometryFormat (any) or null

Формат геометрии в ответе.

boolean or null

Флаг регулирует поведение в случае частично успешного вычисления изохрон. Если флаг установлен, для каждой изохроны будет указан статус вычисления. Если флаг установлен и часть запрошенных изохрон не была посчитана, то будет возвращён код 200 и посчитанные изохроны со статусом OK, а не посчитанные изохроны со статусом build_error. Общий статус будет partial_success. Если все запрошенные изохроны не были посчитаны, то будет возвращён код 200 и выставлен общий статус build_error. Если флаг не указан, то будет возвращён код 204 и пустой ответ.

Responses

Response Schema: application/json
number or null <double>

Время генерации ответа, в секундах.

(Array of Isochrone (object) or FailedIsochrone (object)) or null
TransportV2 (string) or null
StatusV2 (string) or null
format
required
any

Формат геометрии в ответе.

Value: "wkt"

Response samples

Content type
application/json
{
  • "format": "wkt",
  • "generation_time": 0,
  • "isochrones": [
    • {
      },
    • {
      }
    ],
  • "status": "OK",
  • "transport": "public_transport"
}