update_checkpoints
Чтобы обновить список контрольных точек маршрута, используйте метод update_checkpoints:
svc=route/update_checkpoints
params={
"itemId": <long>,
"checkPoints": [
{}
]
}
Параметры
Запрос должен содержать следующие параметры:
| Параметр | Описание |
|---|---|
| itemId | ID маршрута. |
| checkPoints | Массив контрольных точек. |
Формат контрольной точки зависит от ее типа, то есть от того, является ли она контрольной точкой с карты, геозоной или объектом.
Контрольные точки с карты
Формат контрольных точек с карты:
{
"f": 1, // Тип точки.
"n": <text>, // Название.
"y": <double>, // Широта.
"x": <double>, // Долгота.
"r": <uint> // Радиус.
}
Контрольные точки из геозон
Для контрольных точек из геозон возможны два формата:
- формат 1: с указанием поля
gz, содержащего данные геозоны; - формат 2: с указанием ID ресурса и ID геозоны.
Формат 1
{
"f": 2, // Тип точки.
"n": <text>, // Название.
"gz": { // Информация о геозоне.
"n": <text>, // Название геозоны.
"d": <text>, // Описание геозоны.
"id": <long>, // ID геозоны.
"t": <byte>, // Тип геозоны: 1 — линия, 2 — полигон, 3 — окружность.
"w": <uint>, // Ширина линии или радиус окружности.
"f": <uint>, // Флаги геозоны.
"c": <uint>, // Цвет (ARGB).
"b": { // Параметры ограничивающего прямоугольника.
"min_x": <double>, // Минимальная долгота.
"min_y": <double>, // Минимальная широта.
"max_x": <double>, // Максимальная долгота.
"max_y": <double>, // Максимальная широта.
"cen_x": <double>, // Долгота центра.
"cen_y": <double> // Широта центра.
},
"p": [ // Массив точек геозоны.
{
"x": <double>, // Долгота.
"y": <double>, // Широта.
"r": <uint> // Радиус.
}
]
}
}
Формат 2
{
"f": 2, // Тип точки.
"n": <text>, // Название.
"resource": <long>, // ID ресурса, содержащего геозону.
"zone": <long> // ID геозоны в составе ресурса.
}
Контрольные точки из объектов
Формат контрольных точек из объектов:
{
"f": 4, // Тип точки.
"u": <long>, // ID объекта.
"r": <uint> // Радиус.
}
Ответ
Если запрос выполнен успешно, ответ возвращается в следующем формате:
{
"rpts": [ // Массив контрольных точек.
{
"n": <text>, // Название.
"f": <uint>, // Тип.
"u": <long>, // ID объекта (0, если тип не является контрольной точкой из объекта).
"y": <double>, // Широта.
"x": <double>, // Долгота.
"r": <uint> // Радиус.
}
]
}
Если запрос не выполнен, возвращается код ошибки.
Коды ошибок
| Код ошибки | Описание |
|---|---|
| 4 | Неверные входные параметры или ошибка обновления контрольных точек. |
| 6 | Внутренняя ошибка. |
| 7 | Внутренняя ошибка или отсутствует право доступа Редактирование свойств маршрута на маршрут. |