Маршруты
В зависимости от указанных флагов формат ответа может различаться.
На этой странице описаны флаги, которые могут быть применены к маршрутам, и соответствующие им части результирующего JSON, которыми они управляют. Если указано несколько флагов, их соответствующие части объединяются в единый JSON.
Флаги указываются в формате DEC. Подробнее см. в разделе Формат данных.
Содержимое ответа также зависит от ваших прав доступа к элементу. Подробнее см. в разделе Флаги и права доступа.
Флаги маршрутов
К маршрутам могут быть применены следующие флаги:
| Значение в HEX | Значение в DEC | Описание |
|---|---|---|
| 0x00000001 | 1 | Базовый флаг |
| 0x00000002 | 2 | Произвольные свойства |
| 0x00000004 | 4 | Информация о биллинге |
| 0x00000040 | 64 | GUID |
| 0x00000100 | 256 | Конфигурация |
| 0x00000200 | 512 | Контрольные точки |
| 0x00000400 | 1024 | Расписания |
| 0x00000800 | 2048 | Рейсы |
| 0x3FFFFFFFFFFFFFFF | 4611686018427387903 | Установить все возможные флаги маршрута |
Основные свойства
Флаг основных свойств — 0x00000001 (1).
{
"nm": <text>, /* Имя */
"cls": <uint>, /* ID суперкласса avl_route (см. ключ classes в ответе token/login) */
"id": <uint>, /* ID маршрута */
"mu": <uint>, /* Система измерений: 0 — СИ, 1 — американская, 2 — имперская, 3 — метрическая с галлонами */
"uacl": <long> /* Права доступа пользователя к маршруту (64-битное значение) */
}
Произвольные свойства
Флаг произвольных свойств — 0x00000002 (2).
В произвольных свойствах можно хранить любые данные маршрута.
{
"prp": {}, /* Произвольные свойства */
"ftp": { /* Настройки FTP */
"hs": <text>, /* Хост (только если задан) */
"lg": <text>, /* Логин (только если задан) */
"pt": <text>, /* Путь к директории (только если задан) */
"ch": <uint>, /* Валидность настроек FTP: 1 — да, 0 — нет */
"tp": <uint>, /* Использовать FTP Wialon Hosting: 1 — да, 0 — нет */
"fl": <uint> /* Доступность FTP Wialon Hosting: 1 — да, 0 — нет */
},
"ct": <uint> /* Время создания (Unix-время) */
}
Информация о биллинге
Флаг информации о биллинге — 0x00000004 (4).
{
"crt": <uint>, /* ID создателя */
"bact": <uint> /* ID учетной записи */
}
GUID
Флаг GUID — 0x00000040 (64).
{
"gd": <text> /* GUID маршрута */
}
Конфигурация
Флаг конфигурации — 0x00000100 (256).
{
"rcfg":{ /* Конфигурация */
"color":<long>, /* Цвет (ARGB) */
"descr":<text>, /* Описание */
"units":[<long>] /* Массив ID объектов */
}
}
Контрольные точки
Флаг контрольных точек — 0x00000200 (512).
{
"rpts":[ /* Контрольные точки */
{
"n": <text>, /* Имя */
"gz": {}, /* Данные геозоны (только для контрольных точек из геозоны) */
"f": <uint>, /* Тип (см. ниже) */
"u": <long>, /* ID объекта (0, если контрольная точка не является контрольной точкой из объекта) */
"y": <double>, /* Широта (0 для контрольных точек из геозоны или из объекта) */
"x": <double>, /* Долгота (0 для контрольных точек из геозоны или из объекта) */
"r": <uint> /* Радиус: в метрах или в футах, если в маршруте используется американская или имперская система измерений */
},
...
]
}
Контрольные точки могут быть следующих типов:
- 1 — контрольная точка с карты или POI;
- 2 — контрольная точка из геозоны;
- 4 — контрольная точка из объекта.
Объект gz содержит те же данные геозоны, что и возвращаемый результат запроса get_zone_data.
Расписания
Флаг расписаний — 0x00000400 (1024).
{
"rs": { /* Список расписаний */
"<text>": { /* Порядковый номер расписания */
"id": <long>, /* ID расписания */
"n": "<text>", /* Имя */
"f": <uint>, /* Тип */
"tz": <uint>, /* Часовой пояс */
"cfg": { /* Конфигурация (может также содержать другие произвольные ключи) */
"autoName": <byte>, /* Использовать автоматически сгенерированное имя: 0 — нет, 1 — да */
"depEnable": <bool>, /* Контролировать отправление из контрольных точек (столбец «Отправление» на вкладке «Расписание» в свойствах расписания): true — включено, false — отключено */
"description": "<text>", /* Описание рейса */
"enabled": <byte>, /* Создавать рейсы по расписанию автоматически: 1 — включить, 0 — отключить */
"name": "<text>", /* Имя рейса */
"roundFlags": <uint>, /* Флаги рейса */
"units": [<long>], /* Массив ID объектов */
"validityPeriod": <uint> /* Срок действия */
},
"tm": [ /* Время посещения точки */
{
"at": <uint>, /* Время прибытия */
"ad": <uint>, /* Отклонение от времени прибытия */
"dt": <uint>, /* Время отправления */
"dd": <uint> /* Отклонение от времени отправления */
}
],
"sch": { /* Ограничение по времени */
"f1": <uint>, /* Начало интервала 1 */
"f2": <uint>, /* Начало интервала 2 */
"t1": <uint>, /* Конец интервала 1 */
"t2": <uint>, /* Конец интервала 2 */
"m": <uint>, /* Маска дней месяца */
"y": <uint>, /* Маска месяцев */
"w": <uint>, /* Маска дней недели */
"fl": <uint> /* Флаги (для расписаний маршрутов всегда 0) */
},
"ct": <uint>, /* Время создания (Unix-время) */
"mt": <uint> /* Время последнего изменения (Unix-время) */
}
}
}
Типы расписаний описаны в разделе update_schedule.
Рейсы
Флаг рейсов — 0x00000800 (2048).
{
"rr": { /* Рейсы */
"<text>": { /* Порядковый номер рейса */
"id": <long>, /* ID рейса */
"n": "<text>", /* Имя */
"d": "<text>", /* Описание */
"sh": "<text>", /* Имя расписания */
"f": <uint>, /* Флаги рейса */
"tz": <uint>, /* Часовой пояс */
"u": <long>, /* Объект, назначенный на этот рейс */
"at": <uint>, /* Время активации */
"vt": <uint>, /* Время, с которого начинается срок действия */
"vp": <uint>, /* Срок действия */
"sts": <uint>, /* Флаги состояния */
"st": { /* Состояние рейса */
"st": { /* Общее состояние рейса */
"pi": <uint>, /* Индекс контрольной точки (4294967295, если рейс не начался) */
"ps": <uint>, /* Флаги состояния и событий */
"ut": <uint> /* Время последнего события */
},
"pts": { /* Состояние по точкам */
"<text>": { /* Индекс контрольной точки, начиная с 0 */
"st": <uint>, /* Флаги событий */
"tm": <uint> /* Время последнего события */
}
}
},
"ct": <uint>, /* Время создания (Unix-время) */
"mt": <uint> /* Время последнего изменения (Unix-время) */
}
}
}
Значения флагов рейса, состояния и событий описаны в разделе get_round_data.