route_update
Чтобы создать, редактировать или удалить маршрут или переместить его в историю, используйте метод order/route_update.
Конечная точка
svc=order/route_update¶ms={
"itemId": <long>,
"orders": [],
"routeId": <long>,
"callMode": "<text>"
}
Параметры
Обязательные параметры отмечены звездочкой (*).
| Параметр | Описание |
|---|---|
itemId* |
ID ресурса. |
orders |
Массив JSON заявок и callMode для каждой из них. Обязателен, если callMode имеет значение create или update. |
routeId* |
Уникальный ID маршрута (uid в данных маршрута). Вместо routeId можно указать uid с тем же значением или id с ID маршрута. |
callMode* |
Действие: create, update, delete, register, purge. |
При значении delete метод удаляет только маршрут. Его заявки остаются в ресурсе, если не передать их в orders с "callMode": "delete".
При значении register метод перемещает маршрут и его заявки в историю. Чтобы получить их из истории, используйте методы order/get_routes_history и order/get_orders_history.
При значении purge метод удаляет маршрут и все его заявки без их проверки. Заявки берутся из самого маршрута, поэтому передавать их не нужно. Если маршрута с указанным ID не существует, метод не возвращает ошибку.
Для
create,updateиdeleteрезультат аналогичен пакету order/update.
Ответ
Для create, update и delete ответ возвращается в следующем формате:
{
"orders":[{
"id":<uint>, /* ID заявки */
"f":<uint>, /* флаги заявки */
"u":<uint>, /* ID объекта */
"uid":<uint>, /* уникальный ID заявки */
"callMode":"<text>"
},
...
]
}
Для register и purge ответ — пустой объект {}.
Если запрос выполнить не удалось, возвращается код ошибки.
Коды ошибок
| Код ошибки | Описание |
|---|---|
| 4 | Логическая ошибка. Причина указана в ответе. Например, ROUTE_NOT_SPECIFIED, если не указан ID маршрута, или ROUTE_NOT_FOUND, если маршрут, указанный в id, или маршрут для перемещения в историю не существует. |
| 6 | Не удалось создать, обновить маршрут или переместить его в историю либо удалить заявку. |
| 7 | Некорректный ID ресурса. |