get_routes_history
Чтобы получить историю маршрутов, используйте метод order/get_routes_history.
Для использования метода необходимо право доступа Запрос сообщений и отчетов к ресурсу.
Конечная точка
svc=order/get_routes_history¶ms={
"itemId":<long>,
"ivalType":<int>,
"ivalFrom":<uint>,
"ivalTo":<uint>,
"name":"<text>",
"unitId":<long>,
"routeId":<long>
}
Параметры
Обязательные параметры отмечены звездочкой (*).
| Параметр | Значение по умолчанию | Описание |
|---|---|---|
itemId* |
ID ресурса. | |
ivalType |
1 |
Метод выбора интервала. Значения такие же, как у параметра ivalType метода events/load, но вместо timeFrom и timeTo используются ivalFrom и ivalTo. |
ivalFrom |
0 |
Зависит от ivalType: начало интервала (время в формате UNIX) или количество маршрутов для загрузки. |
ivalTo |
UINT_MAX |
Конец интервала (время в формате UNIX). |
name |
Маски имен маршрутов через запятую. Маршрут возвращается, если его имя соответствует хотя бы одной маске. Используйте * для любого количества символов, ? для ровно одного символа и ! в начале маски, чтобы инвертировать ее. Например, "Vil*,Berl*" возвращает маршруты, имена которых начинаются на Vil или Berl, "*kr" возвращает маршруты, имена которых заканчиваются на kr, а "!Vil*" возвращает маршруты, имена которых не начинаются на Vil. |
|
unitId |
ID объекта. | |
routeId |
Уникальный ID маршрута (свойство маршрута uid). |
Ответ
Если запрос выполнен успешно, возвращается следующий результат:
{
"routes":[
{...},
{...},
...
],
"count":<uint>, /* количество отфильтрованных маршрутов (размер "routes") */
"total":<uint> /* общее количество маршрутов за запрашиваемый период */
}
При неудачном выполнении возвращается код ошибки.
Коды ошибок
| Код ошибки | Описание |
|---|---|
| 4 | Неверные входные параметры. |
| 6 | Не удалось загрузить историю, например, из-за недопустимого значения ivalType. |
| 7 | Ресурс не существует, или у пользователя нет права доступа Запрос сообщений и отчетов к нему. |