update_config
Чтобы обновить конфигурацию маршрута, используйте метод route/update_config. Создать маршрут можно с помощью метода core/create_route.
Конфигурация заменяется целиком, а не обновляется по отдельным полям. Указывайте в запросе все необходимые поля: неуказанные поля теряются. Пустой объект
configочищает всю конфигурацию.
Конечная точка
svc=route/update_config
params={
"itemId": <long>,
"config": {
"color": <long>,
"descr": <text>,
"units": [<long>]
}
}
Параметры
Запрос должен содержать параметры itemId и config. Содержимое объекта config не проверяется сервером, поэтому приведенные ниже поля — это поля, которые использует интерфейс Wialon.
| Параметр | Описание |
|---|---|
itemId |
ID маршрута. |
config |
Конфигурация маршрута. |
color |
Цвет маршрута (ARGB). |
descr |
Описание маршрута. |
units |
Массив ID объектов, которые выполняют рейсы. ID не проверяются, поэтому несуществующий ID сохраняется как есть. |
Ответ
Если запрос выполнен успешно, сохраненная конфигурация возвращается в следующем формате:
{
"rcfg": { // Конфигурация маршрута.
"color": <long>, // Цвет маршрута (ARGB).
"descr": <text>, // Описание маршрута.
"units": [<long>] // Массив ID объектов.
}
}
Ответ повторяет конфигурацию из запроса, поэтому содержит только те поля, которые были указаны.
Если запрос не выполнен, возвращается код ошибки.
Коды ошибок
| Код ошибки | Описание |
|---|---|
| 4 | Не удалось разобрать входные параметры или сохранить конфигурацию. |
| 6 | Не удалось сгенерировать ответ. |
| 7 | Маршрут не найден, указанный элемент не является маршрутом или у пользователя нет права доступа Редактирование свойств маршрута на него. |