Ресурсы
В зависимости от указанных флагов формат ответа может различаться. На этой странице описаны флаги, которые можно применять к ресурсам. Также подробно описываются части ответа, которые содержат информацию о флагах. Если указано несколько флагов, их соответствующие части объединяются в один JSON.
Все флаги используются только в десятичном формате (DEC).
Флаги ресурсов
К ресурсам могут быть применены следующие флаги:
| Значение в HEX | Значение в DEC | Описание |
|---|---|---|
| 0x00000001 | 1 | Основные свойства. |
| 0x00000002 | 2 | Пользовательские свойства. |
| 0x00000004 | 4 | Информация о биллинге. |
| 0x00000008 | 8 | Общие произвольные поля. |
| 0x00000020 | 32 | Сообщения. |
| 0x00000040 | 64 | GUID. |
| 0x00000080 | 128 | Административные произвольные поля. |
| 0x00000100 | 256 | Водители. |
| 0x00000200 | 512 | Задания. |
| 0x00000400 | 1024 | Уведомления. |
| 0x00000800 | 2048 | POI. |
| 0x00001000 | 4096 | Геозоны. |
| 0x00002000 | 8192 | Шаблоны отчетов. |
| 0x00004000 | 16384 | Список объектов, на которые водители могут быть назначены автоматически. |
| 0x00008000 | 32768 | Группы водителей. |
| 0x00010000 | 65536 | Прицепы. |
| 0x00020000 | 131072 | Группы прицепов. |
| 0x00040000 | 262144 | Список объектов, на которые прицепы могут быть назначены автоматически. |
| 0x00080000 | 524288 | Заявки. |
| 0x00100000 | 1048576 | Группы геозон. |
| 0x00200000 | 2097152 | Метки (пассажиры). |
| 0x00400000 | 4194304 | Список объектов, на которые метки (пассажиры) могут быть назначены автоматически. |
| 0x00800000 | 8388608 | Группы меток (группы пассажиров). |
| 0x3FFFFFFFFFFFFFFF | 4611686018427387903 | Установить все возможные флаги ресурсов. |
Основные свойства
Флаг основных свойств - 0x00000001.
{
"nm": <text>, /* Имя. */
"cls": <uint>, /* ID базового класса: "avl_resource". */
"id": <uint>, /* ID ресурса. */
"mu": <uint>, /* Система измерений:
0 — СИ,
1 — американская,
2 — имперская,
3 — метрическая с галлонами. */
"uacl": <uint> /* Текущие права доступа пользователя на ресурс. */
}
Пользовательские свойства
Флаг пользовательских свойств — 0x00000002.
В произвольных свойствах можно хранить любые данные ресурса.
{
"prp": { /* Произвольные свойства. */
"emails": "[<text>]", /* Список email-адресов для заданий. */
"nf_rep_emails": "[<text>]", /* Список email-адресов для уведомлений. */
"phones": "[<text>]" /* Список телефонных номеров для задания "Отправка информации о топливе по email или SMS". */
...
},
"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 — нет. */
}
}
Информация о биллинге
Флаг информации о биллинге — 0x00000004.
{
"crt": <uint>, /* ID создателя. */
"bact": <uint>, /* ID учетной записи. */
"bpact": <uint> /* ID родительской учетной записи*/
}
Общие произвольные поля
Флаг произвольных полей — 0x00000008.
{
"flds": { /* Произвольные поля. */
"<uint>": { /* Порядковый номер. */
"id": <uint>, /* ID. */
"n": <text>, /* Имя. */
"v": <text> /* Значение. */
},
...
},
"fldsmax": <long> /* Максимальное количество произвольных полей (-1 для неограниченного количества). */
}
Сообщения
Флаг сообщений — 0x00000020.
После установки этого флага вы можете получать сообщения ресурса.
{}
GUID
Флаг GUID — 0x00000040.
{
"gd":<text> /* GUID ресурса. */
}
Административные произвольные поля
Флаг административных произвольных полей — 0x00000080.
{
"aflds": { /* Административные поля. */
"<uint>": { /* Порядковый номер. */
"id": <uint>, /* ID. */
"n": <text>, /* Имя. */
"v": <text> /* Значение. */
},
...
},
"afldsmax": <long> /* Максимальное количество административных полей (-1 для неограниченного количества). */
}
Водители
Флаг водителей — 0x00000080.
{
"drvrs": {
<text>: { /* Порядковый номер водителя. */
"id": <long>, /* ID. */
"n": <text>, /* Имя. */
"c": <text>, /* Код. */
"pwd": <text>, /* Пароль для мобильной авторизации. */
"ej": <text>, /* Расширенный JSON. */
"jp": { /* Произвольные поля. */
<text>: <text>, /* Имя: значение. */
...
},
"ds": <text>, /* Описание. */
"p": <text>, /* Номер телефона. */
"r": <double>, /* Соотношение сторон изображения. */
"ck": <ushort>, /* Контрольная сумма (CRC16). */
"bu": <long>, /* Назначенный объект. */
"pu": <long>, /* Предыдущий назначенный объект. */
"bt": <uint>, /* Время последнего назначения/снятия. */
"pos": { /* Местоположение. */
"y": <double>, /* Широта. */
"x": <double> /* Долгота. */
},
"infr": { /* Параметры для анализа нарушений режима труда и отдыха водителя (ЕСТР). */
"a": <uint>, /* Текущая активность. */
"t": <uint>, /* Время начала текущей активности. */
"ud": <uint>, /* Длительность непрерывного вождения до текущей активности. */
"ur": <uint>, /* Длительность непрерывного отдыха до текущей активности. */
"uil": <uint>, /* Допустимая длительность непрерывного вождения. */
"uim": <uint>, /* Максимальная длительность непрерывного вождения для незначительного нарушения. */
"uis": <uint>, /* Максимальная длительность непрерывного вождения для критического нарушения. При превышении нарушение классифицируется как критическое. */
"uir": <uint>, /* Требуемая длительность отдыха. */
"ddt": <uint>, /* Время вождения за сутки до текущей активности. */
"ddc": <uint>, /* Количество возможных продлений суточного вождения на этой неделе. */
"ddil": <uint>,/* Допустимая длительность суточного вождения. */
"ddim": <uint>,/* Максимальная длительность суточного вождения для незначительного нарушения. */
"ddis": <uint>,/* Максимальная длительность суточного вождения для значительного нарушения. При превышении нарушение классифицируется как критическое. */
"wdt": <uint>, /* Длительность вождения за неделю до текущей активности. */
"wdil": <uint>,/* Допустимая длительность недельного вождения. */
"wdim": <uint>,/* Максимальная длительность недельного вождения для незначительного нарушения. */
"wdis": <uint>,/* Максимальная длительность недельного вождения для значительного нарушения. При превышении нарушение классифицируется как критическое. */
"twdt": <uint>,/* Длительность вождения за две недели до текущей активности. */
"twdil": <uint>,/* Допустимая длительность двухнедельного вождения. */
"twdim": <uint>,/* Максимальная длительность двухнедельного вождения для незначительного нарушения. */
"twdis": <uint>,/* Максимальная длительность двухнедельного вождения для значительного нарушения. При превышении нарушение классифицируется как критическое. */
"drt": <uint>, /* Длительность предыдущего суточного отдыха. */
"drd": <uint>, /* Требуемая длительность суточного отдыха. */
"dril": <uint>, /* Время, до которого должен быть осуществлен суточный отдых. */
"drim": <uint>, /* Время, до которого нарушение классифицируется как незначительное. */
"dris": <uint>, /* Время, до которого нарушение классифицируется как значительного. При превышении нарушение классифицируется как критическое. */
"wrt": <uint>, /* Длительность предыдущего недельного отдыха. */
"wrd": <uint>, /* Требуемая длительность недельного отдыха. */
"wril": <uint>, /* Время, до которого должен быть осуществлен недельный отдых. */
"wrim": <uint>, /* Время, до которого нарушение классифицируется как незначительное. */
"wris": <uint> /* Время, до которого нарушение классифицируется как значительное. При превышении нарушение классифицируется как критическое. */
}
},
...
},
"drvrsmax": <long> /* Максимальное количество водителей (-1 для неограниченного количества). */
}
Задания
Флаг заданий — 0x00000200.
{
"ujb": {
"<text>": { /* Порядковый номер задания. */
"id": <uint>, /* ID. */
"n": <text>, /* Имя. */
"d": <text>, /* Описание. */
"m": <uint>, /* Максимально допустимое количество выполнений. */
"st": { /* Состояние. */
"e": <uint>, /* Активно (1) / Неактивно (0). */
"c": <uint>, /* Количество выполнений. */
"l": <uint> /* Время последнего выполнения (UTC). */
},
"act": <text> /* Тип действия. */
},
...
},
"ujbmax": <long> /* Максимальное количество заданий (-1 для неограниченного количества). */
}
Типы действий описаны в разделе get_job_data.
Уведомления
Флаг уведомлений — 0x00000400.
{
"unf": {
"<text>": { /* Порядковый номер уведомления. */
"id": <long>, /* ID уведомления. */
"n": <text>, /* Имя. */
"ta": <uint>, /* Время активации. */
"td": <uint>, /* Время деактивации. */
"ma": <uint>, /* Максимальное количество срабатываний (0 для неограниченного количества). */
"fl": <uint>, /* Типы уведомлений. */
"ac": <uint>, /* Количество срабатываний. */
"un": [<long>], /* Массив ID объектов. */
"act": [<text>], /* Список действий. */
"trg": <text>, /* Тип контроля.. */
"crc": <long> /* Контрольная сумма бинарного представления уведомления. */
},
...
},
"unfmax": <long> /* Максимальное количество уведомлений (-1 для неограниченного количества). */
}
Типы действий, типы контроля и флаги уведомлений описаны в разделе get_notification_data.
POI
Флаг POIs — 0x00000800.
{
"poi": {
"<text>": { /* Порядковый номер POI. */
"id": <long>, /* ID POI. */
"n": <text>, /* Имя. */
"y": <double>, /* Широта. */
"x": <double>, /* Долгота */
"t": <double>, /* Соотношение сторон изображения */
"i": <short>, /* Контрольная сумма изображения (CRC16) */
"e": <ushort> /* Контрольная сумма POI (CRC16) */
},
...
},
"poimax": <long> /* Максимальное количество POI (-1 для неограниченного количества) */
}
Геозоны
Флаг геозон — 0x00001000.
{
"zl": {
"<text>": { /* Порядковый номер геозоны. */
"n": <text>, /* Имя. */
"d": <text>, /* Описание. */
"id": <long>, /* ID.*/
"f": <uint>, /* Флаги. */
"t": <int>, /* Тип: 1 — линия, 2 — полигон, 3 — круг. */
"e": <ushort>, /* Контрольная сумма (CRC16).*/
"b": { /* Настройки отрисовки геозон. */
"min_x": <double>, /* Минимальная долгота. */
"min_y": <double>, /* Минимальная широта. */
"max_x": <double>, /* Максимальная долгота. */
"max_y": <double>, /* Максимальная широта. */
"cen_x": <double>, /* Долгота центра геозоны. */
"cen_y": <double> /* Широта центра геозоны. */
}
},
...
},
"zlmax": <long> /* Максимальное количество геозон (-1 для неограниченного количества) */
}
Флаги геозон описаны в разделе get_zone_data.
Шаблоны отчетов
Флаг шаблонов отчетов — 0x00002000.
{
"rep": {
<text>: { /* Порядковый номер шаблона */
"id": <long>, /* ID шаблона */
"n": <text>, /* Имя шаблона */
"ct": <text>, /* Тип шаблона */
"c": <ushort> /* Контрольная сумма (CRC16) */
},
...
},
"repmax": <long> /* Максимальное количество шаблонов (-1 для неограниченного количества) */
}
Типы шаблонов описаны в разделе get_report_data.
Список объектов, на которые водители могут быть назначены автоматически
Флаг объектов, на которые водители могут быть назначены автоматически — 0x00004000.
{
"drvrun": [<long>] /* Массив ID объектов.*/
}
Группы водителей
Флаг групп водителей — 0x00008000.
{
"drvrsgr": { /* Группы водителей. */
<text>: { /* Порядковый номер группы. */
"id": <long>, /* ID группы. */
"n": <text>, /* Имя группы. */
"d": <text>, /* Описание группы. */
"drs": [<uint>] /* Массив ID водителей. */
},
...
},
"drvrsgrmax": <long> /* Максимальное количество групп водителей (-1 для неограниченного количества). */
}
Прицепы
Флаг прицепов — 0x00010000
{
"trlrs": { /* Прицепы. */
<text>: { /* Порядковый номер прицепа. */
"id": <long>, /* ID прицепа. */
"n": <text>, /* Имя прицепа. */
"c": <text>, /* Код прицепа. */
"ej": <text>, /* Расширенный JSON. */
"jp": { /* Произвольные поля. */
<text>: <text>, /* Имя: значение. */
...
},
"ds": <text>, /* Описание. */
"p": <text>, /* Номер телефона. */
"r": <double>, /* Соотношение сторон изображения. */
"ck": <short>, /* Контрольная сумма изображения. */
"bu": <long>, /* Назначенный объект. */
"pu": <long>, /* Предыдущий назначенный объект. */
"bt": <uint>, /* Время последнего назначения/снятия. */
"pos": { /* Местоположение. */
"y": <double>, /* Широта. */
"x": <double> /* Долгота. */
}
}
},
"trlrsmax": <long> /* Максимальное количество прицепов (-1 для неограниченного количества). */
}
Группы прицепов
Флаг групп прицепов — 0x00020000.
{
"trlrsgr": { /* Группы прицепов. */
<text>: { /* Порядковый номер группы. */
"id": <long>, /* ID группы. */
"n": <text>, /* Имя группы. */
"d": <text>, /* Описание группы. */
"drs": [<uint>] /* Массив ID прицепов. */
}
},
"trlrsgrmax": <long> /* Максимальное количество групп прицепов (-1 для неограниченного количества). */
}
Список объектов, на которые прицепы могут быть назначены автоматически
Флаг объектов, на которые прицепы могут быть назначены автоматически — 0x00040000.
{
"trlrun": [<long>] /* Массив ID объектов. */
}
Заявки
Флаг заявок — 0x00080000.
{
"orders":{
"<uint>": { /* Номер заявки, такой же как в параметре "id". */
"id":<uint>, /* ID заявки в ресурсе. */
"n":<text>, /* Имя заявки. */
"p":{ /* Пользовательское содержимое объекта. */
...
},
"f":<bool>, /* Флаги заявки: 1 — заявка будет отмечена как выполненная, если было хотя бы одно сообщение в зоне заявки с нулевой скоростью. */
"tf":<uint>, /* Начало интервала выполнения заявки. */
"tt":<uint>, /* Конец интервала выполнения заявки. */
"uid":<uint>, /* Уникальный id (используется как уникальный ключ в истории заявок). */
"r":<uint>, /* Радиус точки заявки. */
"y":<double>, /* Широта точки заявки. */
"x":<double>, /* Долгота точки заявки. */
"u":<long>, /* ID объекта. */
"s":<uint>, /* Статус заявки: 0 — неактивна (объект не назначен), 1 — активна (объект назначен), 2 — выполнена вовремя, 3 — выполнена с опозданием, 4 — отменена (не используется). */
"st":<uint> /* Время последнего изменения статуса. */
},
...
}
}
Группы геозон
Флаг групп геозон — 0x00100000.
{
"zg": { /* Группы геозон. */
"<text>": { /* Порядковый номер группы. */
"id": <long>, /* ID группы. */
"n": <text>, /* Имя. */
"d": <text>, /* Описание. */
"drs": [<uint>] /* Массив ID геозон. */
},
...
},
"zgmax": <long> /* Максимальное количество групп геозон (-1 для неограниченного количества). */
}
Метки (пассажиры)
Флаг меток (пассажиров) — 0x00200000.
{
"item": {
"tags": {
"<uint>": { /* ID метки. */
"id": <uint>, /* ID метки. */
"n": <text>, /* Имя метки. */
"c": <text>, /* Код метки. */
"jp": { /* Произвольные поля (ключ:значение). */
"<text>": <text>
},
"r": <double>, /* Соотношение сторон изображения. */
"ck": <ushort>, /* Контрольная сумма (CRC16). */
"bu": <long>, /* Назначенный объект. */
"pu": <long>, /* Предыдущий назначенный объект. */
"bt": <uint>, /* Время последнего назначения/снятия. */
"tz": <int>, /* Часовой пояс. */
"pos": { /* Местоположение. */
"y": <double>, /* Широта. */
"x": <double> /* Долгота. */
}
},
...
},
"tagsmax": -1 /* Максимальное количество меток (-1 для неограниченного количества). */
}
}
Список объектов, на которые метки могут быть назначены автоматически
Флаг объектов, на которые метки могут быть назначены автоматически — 0x00400000.
{
"tagrun":[<long>] /* Массив ID объектов. */
}
Группы меток (группы пассажиров)
Флаг групп меток (групп пассажиров) — 0x00800000.
{
"tagsgr": {
<long>: { /* ID группы.*/
"id": <long>, /* ID группы.*/
"n": <text>, /* Имя группы. */
"d": <text>, /* Описание. */
"tgs": [<uint>] /* Массив ID меток. */
},
...
}
"tagsgrmax": -1 /* Максимальное количество групп. */
}