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

POST /get_hull

Спецификация 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"

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

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

simplify
boolean
Deprecated
Default: true

Детализированность многоугольника:

  • true - низкая
  • false - высокая
Устаревший параметр, используйте detailing.

Responses

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

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

Array of Geometry (objects) or null
Transport (string) or null
Transport (string) or null
Status (string) or null
string or null

Детальное описание ошибки, если она была.

Response samples

Content type
application/json
{
  • "generation_time": 0.1,
  • "geometries": [
    • {
      },
    • {
      }
    ],
  • "status": "OK",
  • "transport": "walking"
}