VRt.Routing [RT] (7.6.2491)

Veeroute Support Team: servicedesk@veeroute.com License: Proprietary Terms of Service

Сайт компании Veeroute

Описание

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

Возможности

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

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

erd

Route

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

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

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

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

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

required	Array of objects (route_waypoint) [ 2 .. 15001 ] items Массив географических точек, между которыми нужно проложить путь.
transport_type	string (transport_type) Enum: "CAR" "TRUCK_1500" "TRUCK_3000" … 13 more Example: "CAR" Типы транспорта: `CAR` - легковой автомобиль `TRUCK_1500` - грузовой автомобиль с разрешенной массой не более 1500 кг `TRUCK_3000` - грузовой автомобиль с разрешенной массой не более 3000 кг `TRUCK_5000` - грузовой автомобиль с разрешенной массой не более 5000 кг `TRUCK_10000` - грузовой автомобиль с разрешенной массой не более 10000 кг `TRUCK_20000` - грузовой автомобиль с разрешенной массой не более 20000 кг `TRUCK_10000_L75_H35_W24_6000` - грузовой автомобиль с разрешенной массой не более 10000 кг, габаритами 7.5 x 3.5 x 2.4 метров, допустимой нагрузкой на ось 6000 кг `TRUCK_18000_L95_H40_W26_11000` - грузовой автомобиль с разрешенной массой не более 18000 кг, габаритами 9.5 x 4.0 x 2.6 метров, допустимой нагрузкой на ось 11000 кг `TRUCK_26000_L120_H40_W26_8000` - грузовой автомобиль с разрешенной массой не более 26000 кг, габаритами 12.0 x 4.0 x 2.6 метров, допустимой нагрузкой на ось 8000 кг `TRUCK_GARBAGE_1` - грузовой автомобиль для перевозки мусора (тип 1) `TRUCK_GARBAGE_2` - грузовой автомобиль для перевозки мусора (тип 2) `TUK_TUK` - моторикша `BICYCLE` - велосипед `PEDESTRIAN` - пешеход `PUBLIC_TRANSPORT` - общественный транспорт `TELEPORT` - телепорт (мгновенное перемещение между точками) Разрешенная масса - это масса снаряженного транспорта с грузом и водителем, установленная предприятием-изготовителем в качестве максимально допустимой.
	object (geo_settings) Настройки использования гео-данных.
departure_time	string or null <date-time> Default: null Example: "2024-08-21T09:30:00+03:00" Дата и время отправления в соответствии с ISO 8601.
result_timezone	integer <int32> (timezone) [ -12 .. 12 ] Example: "3" Временная зона, в которой возвращается результат расчета.
detail	boolean Default: false Example: "true" Построение детального пути - добавляет пути от точек, которые не находятся на дорогах, до ближайших дорог.
full_segments	boolean Default: true Example: "false" Возвращать полный список сегментов пути. Если опция выключена - возвращается краткий список для упрощенного отображения пути.
polyline	boolean Default: true Example: "false" Построение пути перемещения между точками.
trackpoint_time	boolean Default: false Example: "true" Создавать времена у промежуточных точек пути.
dataset_name	string (dataset_name) [ 0 .. 512 ] characters Example: "custom_dataset_one" Название набора данных. Техническое поле, не влияющее на расчет.

Responses

Response Schema: application/json

required	object (tracedata) Данные используемые для трассировки запросов.
required	object (route) Информация о построенном маршруте.

Request samples

Payload
Python

Content type

application/json

{"transport_type": "CAR",
"detail": true,
"polyline": true,
"waypoints": [{"name": "waypoint_01",
"duration": "PT10M",
"geopoint": {"latitude": 55.7464,
"longitude": 37.493
}
},
{"name": "waypoint_02",
"duration": "PT10M",
"geopoint": {"latitude": 55.6044,
"longitude": 37.6639
}
},
{"name": "waypoint_03",
"duration": "PT10M",
"geopoint": {"latitude": 55.7305,
"longitude": 37.7387
}
},
{"name": "waypoint_04",
"duration": "PT10M",
"geopoint": {"latitude": 55.7329,
"longitude": 37.6437
}
},
{"name": "waypoint_05",
"duration": "PT10M",
"geopoint": {"latitude": 55.7974,
"longitude": 37.7994
}
}
]
}

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "ROUTING",
"operation": "run_route_calculation",
"time": "2024-08-23T15:38:46.819189Z"
},
"route": {"legs": [{"steps": [{"transport_type": "CAR",
"polyline": [{"latitude": 55.746479,
"longitude": 37.49293,
"time": "2024-08-23T15:42:41Z"
},
{"latitude": 55.746405,
"longitude": 37.492664,
"time": "2024-08-23T15:42:42Z"
},
{"latitude": 55.746625,
"longitude": 37.492461,
"time": "2024-08-23T15:42:43Z"
}
]
}
],
"departure_name": "waypoint_01",
"destination_name": "waypoint_02",
"statistics": {"distance": 17101,
"time_window": {"from": "2024-08-23T17:58:45Z",
"to": "2024-08-23T18:35:45Z"
},
"duration": "PT27M",
"stopping_time": "PT10M"
}
}
],
"statistics": {"distance": 17101,
"time_window": {"from": "2024-08-23T17:58:45Z",
"to": "2024-08-23T18:35:45Z"
},
"duration": "PT27M",
"stopping_time": "PT10M"
}
}
}

Matrix

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

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

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

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

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

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

required	Array of objects (routing_matrix_waypoint) [ 2 .. 15001 ] items Массив географических точек, между которыми (попарно) нужно вычислить расстояния и времена.
transport_type	string (transport_type) Enum: "CAR" "TRUCK_1500" "TRUCK_3000" … 13 more Example: "CAR" Типы транспорта: `CAR` - легковой автомобиль `TRUCK_1500` - грузовой автомобиль с разрешенной массой не более 1500 кг `TRUCK_3000` - грузовой автомобиль с разрешенной массой не более 3000 кг `TRUCK_5000` - грузовой автомобиль с разрешенной массой не более 5000 кг `TRUCK_10000` - грузовой автомобиль с разрешенной массой не более 10000 кг `TRUCK_20000` - грузовой автомобиль с разрешенной массой не более 20000 кг `TRUCK_10000_L75_H35_W24_6000` - грузовой автомобиль с разрешенной массой не более 10000 кг, габаритами 7.5 x 3.5 x 2.4 метров, допустимой нагрузкой на ось 6000 кг `TRUCK_18000_L95_H40_W26_11000` - грузовой автомобиль с разрешенной массой не более 18000 кг, габаритами 9.5 x 4.0 x 2.6 метров, допустимой нагрузкой на ось 11000 кг `TRUCK_26000_L120_H40_W26_8000` - грузовой автомобиль с разрешенной массой не более 26000 кг, габаритами 12.0 x 4.0 x 2.6 метров, допустимой нагрузкой на ось 8000 кг `TRUCK_GARBAGE_1` - грузовой автомобиль для перевозки мусора (тип 1) `TRUCK_GARBAGE_2` - грузовой автомобиль для перевозки мусора (тип 2) `TUK_TUK` - моторикша `BICYCLE` - велосипед `PEDESTRIAN` - пешеход `PUBLIC_TRANSPORT` - общественный транспорт `TELEPORT` - телепорт (мгновенное перемещение между точками) Разрешенная масса - это масса снаряженного транспорта с грузом и водителем, установленная предприятием-изготовителем в качестве максимально допустимой.
	object (geo_settings) Настройки использования гео-данных.
departure_time	string or null <date-time> Default: null Example: "2024-08-21T09:30:00+03:00" Дата и время отправления в соответствии с ISO 8601.
dataset_name	string (dataset_name) [ 0 .. 512 ] characters Example: "custom_dataset_one" Название набора данных. Техническое поле, не влияющее на расчет.

Responses

Response Schema: application/json

required	object (tracedata) Данные используемые для трассировки запросов.
required	object (routing_matrix) Матрица маршрутизации. Содержит времена и расстояний между точками.

Request samples

Payload

Content type

application/json

{"transport_type": "CAR",
"waypoints": [{"name": "waypoint_01",
"geopoint": {"latitude": 55.7464,
"longitude": 37.493
}
},
{"name": "waypoint_02",
"geopoint": {"latitude": 55.6044,
"longitude": 37.6639
}
},
{"name": "waypoint_03",
"geopoint": {"latitude": 55.7305,
"longitude": 37.7387
}
},
{"name": "waypoint_04",
"geopoint": {"latitude": 55.7329,
"longitude": 37.6437
}
},
{"name": "waypoint_05",
"geopoint": {"latitude": 55.7974,
"longitude": 37.7994
}
}
]
}

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "ROUTING",
"operation": "run_matrix_calculation",
"time": "2024-08-23T15:42:47.418015Z"
},
"matrix": {"waypoints": [{"geopoint": {"latitude": 55.7305,
"longitude": 37.7387
},
"name": "waypoint_03"
},
{"geopoint": {"latitude": 55.7464,
"longitude": 37.493
},
"name": "waypoint_01"
},
{"geopoint": {"latitude": 55.6044,
"longitude": 37.6639
},
"name": "waypoint_02"
},
{"geopoint": {"latitude": 55.7974,
"longitude": 37.7994
},
"name": "waypoint_05"
},
{"geopoint": {"latitude": 55.7329,
"longitude": 37.6437
},
"name": "waypoint_04"
}
],
"distances": [[0,
20315,
37877,
24153,
17333
],
[29204,
0,
15069,
20098,
9181
],
[36075,
15410,
0,
23216,
16063
],
[25718,
23050,
24467,
0,
12455
],
[17072,
6901,
16961,
13555,
0
]
],
"durations": [[0,
20,
28,
26,
18
],
[23,
0,
16,
22,
9
],
[27,
16,
0,
25,
17
],
[26,
20,
24,
0,
14
],
[18,
7,
17,
15,
0
]
]
}
}

System

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

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

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

Responses

Response Schema: application/json

health

required

number <double> [ 0 .. 1 ]

Example: "0.999"

Текущий показатель здоровья сервиса.

0.0 означает неготовность сервиса выполнять задачи.
1.0 означает полную готовность сервиса для выполнения задач.

Response samples

200
404
429
500

Content type

application/json

{"health": 0.999
}

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

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

Responses

Response Schema: application/json

major required	integer <int32> [ 1 .. 100 ] Example: "7" Версия продукта. В рамках одной версии гарантируется совместимость общих структур данных между сервисами. Изменение версии указывает на несовместимые с предыдущими версиями продукта (и, соответственно, всех сервисов) изменения.
minor required	integer <int32> [ 0 .. 111 ] Example: "5" Минорная версия сервиса. Изменение версии указывает на новую функциональность. Обновление имеет обратную совместимость в рамках мажорной версии сервиса.
build required	string [ 1 .. 64 ] characters Example: "3754RC" Версия сборки. Изменяется при обновлении документации и исправлении ошибок.

Response samples

200
404
429
500

Content type

application/json

{"major": 7,
"minor": 5,
"build": "3754RC"
}

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

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

path Parameters

filename

required

string [ 6 .. 128 ] characters

Example: file_en.html

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

Responses

Response Schema:
text/html

string (file_html)

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

Response samples

404
429
500

Content type

application/json

{"resource_key": "resource_key",
"detail": {"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2024-08-21T09:30:00+03:00"
}
}
}

VRt.Routing [RT] (7.6.2491)

Описание

Возможности

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

Route

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

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Matrix

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

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

System

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

Responses

Response Schema: application/json

Response samples

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

Responses

Response Schema: application/json

Response samples

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

path Parameters

Responses

Response Schema: text/htmltext/plaintext/html

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Response Schema:
text/html