Содержание
Ресурсы
В зависимости от установленных флагов формат ответа может варьироваться.
В данном разделе рассмотрены флаги, применимые к ресурсам, и части результирующего JSON, за которые они отвечают. При указании нескольких флагов части будут собираться в один 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 | 65636 | прицепы |
| 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 - si, 1 - us, 2 - имперская, 3 - метрическая с галлонами */ "uacl":<uint> /* уровень доступа к ресурсу у текущего пользователя */ }
Произвольные свойства
Флаг - 0x00000002
В произвольных свойствах вы можете сохранять любые нужные вам данные о ресурсе.
{ "prp":{ /* произвольные свойства */ "emails":"[<text>]", /* список e-mail для заданий */ "nf_rep_emails":"[<text>]", /* список e-mail для уведомлений */ "phones":"[<text>]", /* список телефонов для задания "отправить информацию о топливе" */ ... }, "ftp": { /* настройки FTP */ "hs":<text>, /* хост */ "lg":<text>, /* логин */ "pt":<text>, /* путь к папке */ "ch": <uint>, /* валидность настроек FTP: 1-да(по умолчанию), 0-нет */ "tp": <uint>, /* отправлять данные на wialon hosting FTP: 1 - да, 0 - нет */ "fl": <uint> /* признак наличия wialon hosting FTP: 1 - да, 0 - нет */ } }
Биллинг
Флаг - 0x00000004
{ "crt":<uint>, /* ID создателя */ "bact":<uint>, /* ID учетной записи */ "bpact":<uint> /* ID создателя учетной записи */ }
Произвольные поля
Flag - 0x00000008
{ "flds":{ /* произвольные поля */ "<uint>":{ /* порядковый номер */ "id":<uint>, /* ID */ "n":<text>, /* название */ "v":<text> /* значение */ }, ... }, "fldsmax":<long>, /* максимально допустимое количество произвольных полей (-1 - не ограничено) */ }
Сообщения
Флаг - 0x00000020
Установка данного флага позволяет принимать сообщения от объекта.
{}
GUID
Флаг - 0x00000040
{ "gd":<text> /* GUID ресурса */ }
Административные поля
Flag - 0x00000080
{ "aflds":{ /* административные поля */ "<uint>":{ /* порядковый номер */ "id":<uint>, /* ID */ "n":<text>, /* название */ "v":<text> /* значение */ }, ... }, "afldsmax":<long>, /* максимально допустимое количество административных полей (-1 - не ограничено) */ }
Водители
Флаг - 0x00000100
{ "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 - не ограничено) */ }
Группы водителей
Флаг - 0x00008000
{ "drvrsgr":{ /* группы водителей */ <text>:{ /* порядковый номер группы */ "id":<long>, /* ID группы */ "n":<text>, /* название */ "d":<text>, /* описание */ "drs":[<uint>] /* массив ID водителей */ }, ... }, "drvrsgrmax":<long> /* максимальное количество групп водителей, разрешенное тарифным планом (-1 - не ограничено) */ }
Задания
Флаг - 0x00000200
{ "ujb":{ <text>:{ /* порядковый номер задания */ "id":<uint>, /* ID */ "n":<text>, /* название */ "d":<text>, /* описание */ "m":<uint>, /* максимальное разрешенное количество выполнений */ "st":{ /* состояние */ "e":<uint>, /* активно/неактивно */ "c":<uint>, /* количество выполнений */ "l":<uint> /* время последнего выполнения */ }, "act":<text> /* тип действия */ }, ... }, "ujbmax":<long>, /* максимальное количество заданий, разрешенное тарифным планом (-1 - не ограничено) */ }
Типы действий рассмотрены в разделе Задания: подробная информация.
Уведомления
Флаг - 0x00000400
{ "unf":{ <text>:{ /* порядковый номер уведомления */ "id":<long>, /* ID */ "n":<text>, /* название */ "ta":<uint>, /* время активации */ "td":<uint>, /* время деактивации */ "ma":<uint>, /* максимальное количество срабатываний */ "fl":<uint>, /* флаги уведомлений */ "ac":<uint>, /* количество срабатываний */ "un":[<long>], /* массив идентификаторов объектов */ "act":[<text>], /* список действий */ "trg":<text>, /* тип контроля */ "crc":<long> /* контрольная сумма бинарного представления уведомления */ }, ... }, "unfmax":<long>, /* максимальное количество уведомлений, разрешенное тарифным планом (-1 - не ограничено) */ }
Типы действий,типы контроля и флаги уведомлений подробней рассмотрены в разделе Уведомления: подробная информация.
POI
Флаг - 0x00000800
> { "poi":{ <text>:{ /* порядковый номер POI */ "id":<long>, /* ID */ "n":<text>, /* название */ "y":<double>, /* широта */ "x":<double>, /* долгота */ "t":<double>, /* соотношение сторон изображения */ "i":<short>, /* контрольная сумма POI (CRC16) */ "e":<ushort> /* контрольная сумма изображения (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 - не ограничено) */ }
Флаги геозон рассмотрены в разделе Геозоны: подробная информация.
Группы геозон
Флаг - 0x00100000
{ "zg":{ /* группы геозон */ <text>:{ /* порядковый номер группы */ "id":<long>, /* ID группы */ "n":<text>, /* название */ "d":<text>, /* описание */ "zns":[<uint>] /* массив ID геозон */ } }, "zgmax":<long> /* максимальное количество групп геозон, разрешенное тарифным планом (-1 - не ограничено) */ }
Шаблоны отчетов
Флаг - 0x00002000
{ "rep":{ <text>:{ /* порядковый номер шаблона */ "id":<long>, /* ID */ "n":<text>, /* название */ "ct":<text>, /* тип шаблона (см. список внизу) */ "c":<ushort> /* контрольная сумма (CRC16) */ }, ... }, "repmax":<long> /* максимальное количество шаблонов, разрешенное тарифным планом (-1 - не ограничено) */ }
Типы шаблонов рассмотрены в разделе Получить данные о шаблонах.
Список объектов для автоматического прикрепления водителей
Флаг - 0x00004000
{ "drvrun":[<long>] /* массив ID объектов для автоматического прикрепления */ }
Прицепы
Флаг - 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> /* время последней смены статуса */ }, ... } }
Метки (пассажиры)
Флаг - 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 /* максимально разрешенное количество меток */ },
Список объектов для автоматического прикрепления меток(пассажиров)
Флаг - 0x00400000
{ "tagrun":[<long>] /* массив ID объектов для автоматического прикрепления */ }
Группы меток(пассажиров)
Флаг - 0x00800000
{ tagsgr: { /* группы меток*/ <long>: { /* ID группы */ id: <long>, /* ID группы */ n: <text>, /* имя группы */ d: <text>, /* описание группы */ tgs: [<uint>] /* массив ID меток в группе */ }, ... } tagsgrmax: -1 /* ограничение на количество групп */ }
