VRt.Routing [RO] (6.20.2289)

Описание

Основное назначение VRt.Routing - построение пути проезда между точками и расчет матриц расстояний и времен.

Возможности

  • Получение расстояния и времени между двумя точками с учетом пробок
  • Построение пути по заданным точкам
  • Построение матрицы расстояний и времен

Диаграмма сущностей

erd

Route

Построение пути передвижения между географическими точками.

Путь между точками

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

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Новый запрос на расчет пути.

required
Array of objects (waypoint) [ 2 .. 15001 ] items

Массив географических точек, между которыми нужно проложить путь.

transport_type
string (transport_type)
Enum: "CAR" "TRUCK_1500" "TRUCK_3000" … 9 more

Типы транспорта:

  • CAR - легковой автомобиль
  • TRUCK_1500 - грузовой автомобиль с разрешенной массой не более 1500 кг
  • TRUCK_3000 - грузовой автомобиль с разрешенной массой не более 3000 кг
  • TRUCK_5000 - грузовой автомобиль с разрешенной массой не более 5000 кг
  • TRUCK_10000 - грузовой автомобиль с разрешенной массой не более 10000 кг
  • TRUCK_20000 - грузовой автомобиль с разрешенной массой не более 20000 кг
  • TRUCK_GARBAGE_1 - грузовой автомобиль для перевозки мусора (тип 1)
  • TRUCK_GARBAGE_2 - грузовой автомобиль для перевозки мусора (тип 2)
  • TUK_TUK - моторикша
  • BICYCLE - велосипед
  • PEDESTRIAN - пешеход
  • PUBLIC_TRANSPORT - общественный транспорт

Разрешенная масса - это масса снаряженного транспорта с грузом и водителем, установленная предприятием-изготовителем в качестве максимально допустимой.

object (geo_settings)

Настройки использования гео-данных.

departure_time
string or null<date-time>

Дата и время отправления в соответствии с ISO 8601.

result_timezone
integer<int32> [ -12 .. 12 ]
Default: 0

Временная зона, в которой возвращается результат расчета.

detail
boolean
Default: false

Построение детального пути - добавляет пути от точек, которые не находятся на дорогах, до ближайших дорог.

full_segments
boolean
Default: true

Возвращать полный список сегментов пути. Если опция выключена - возвращается краткий список для упрощенного отображения пути.

polyline
boolean
Default: true

Построение пути перемещения между точками.

Responses

Response Schema: application/json
required
object (tracedata)

Данные используемые для трассировки запросов.

required
object (route)

Информация о построенном маршруте.

Request samples

Content type
application/json
{
  • "transport_type": "CAR",
  • "detail": true,
  • "polyline": true,
  • "waypoints": [
    ]
}

Response samples

Content type
application/json
{
  • "tracedata": {
    },
  • "route": {
    }
}

Matrix

Построение матрицы маршрутизации.

Для построения матрицы не учитывается параметр geo_provider, всегда используется гео-провайдер по-умолчанию.

Матрица времен и расстояний

Построение матриц расстояний и времени попарно между указанными точками. Результат работы данного метода может незначительно отличатся от метода route.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Новый запрос на расчет матрицы.

required
Array of objects (waypoint) [ 2 .. 15001 ] items

Массив географических точек, между которыми (попарно) нужно вычислить расстояния и времена.

transport_type
string (transport_type)
Enum: "CAR" "TRUCK_1500" "TRUCK_3000" … 9 more

Типы транспорта:

  • CAR - легковой автомобиль
  • TRUCK_1500 - грузовой автомобиль с разрешенной массой не более 1500 кг
  • TRUCK_3000 - грузовой автомобиль с разрешенной массой не более 3000 кг
  • TRUCK_5000 - грузовой автомобиль с разрешенной массой не более 5000 кг
  • TRUCK_10000 - грузовой автомобиль с разрешенной массой не более 10000 кг
  • TRUCK_20000 - грузовой автомобиль с разрешенной массой не более 20000 кг
  • TRUCK_GARBAGE_1 - грузовой автомобиль для перевозки мусора (тип 1)
  • TRUCK_GARBAGE_2 - грузовой автомобиль для перевозки мусора (тип 2)
  • TUK_TUK - моторикша
  • BICYCLE - велосипед
  • PEDESTRIAN - пешеход
  • PUBLIC_TRANSPORT - общественный транспорт

Разрешенная масса - это масса снаряженного транспорта с грузом и водителем, установленная предприятием-изготовителем в качестве максимально допустимой.

object (geo_settings)

Настройки использования гео-данных.

departure_time
string or null<date-time>

Дата и время отправления в соответствии с ISO 8601.

Responses

Response Schema: application/json
required
object (tracedata)

Данные используемые для трассировки запросов.

required
object (routing_matrix)

Матрица расстояний и времен.

Request samples

Content type
application/json
{
  • "transport_type": "CAR",
  • "waypoints": [
    ]
}

Response samples

Content type
application/json
{
  • "tracedata": {
    },
  • "matrix": {
    }
}

System

Системные функции. Вспомогательный функционал, общий для всех сервисов.

Проверка доступности

Проверка доступности сервиса.

Responses

Response Schema: application/json
health
required
number<double> [ 0 .. 1 ]

Текущий показатель здоровья сервиса.
0 означает неготовность сервиса выполнять задачи.
1 означает полную готовность сервиса для выполнения задач.

Response samples

Content type
application/json
{
  • "health": 0.999
}

Получение версии сервиса

Получение версии сервиса.

Responses

Response Schema: application/json
major
required
integer<int32> [ 1 .. 100 ]

Версия продукта. В рамках одной версии гарантируется совместимость общих структур данных между сервисами.
Изменение версии указывает на несовместимые с предыдущими версиями продукта (и, соответственно, всех сервисов) изменения.

minor
required
integer<int32> [ 0 .. 111 ]

Минорная версия сервиса. Изменение версии указывает на новую функциональность. Обновление имеет обратную совместимость в рамках мажорной версии сервиса.

build
required
string [ 1 .. 64 ] characters

Версия сборки.
Изменяется при обновлении документации и исправлении ошибок.

Response samples

Content type
application/json
{
  • "major": 4,
  • "minor": 4,
  • "build": "1754RC"
}

Получение документации

Получение файла с документацией на этот сервис.

path Parameters
filename
required
string [ 6 .. 128 ] characters
Example: file_en.html

Название файла.

Responses

Response Schema:
string (file_html)

Файл с данными в формате HTML.

Response samples

Content type
application/json
{
  • "resource_id": "resource_id",
  • "detail": {
    }
}