В зависимости от установленных флагов формат ответа может варьироваться.
В данном разделе рассмотрены флаги, применимые к объектам, и части результирующего JSON, за которые они отвечают. При указании нескольких флагов части будут собираться в один JSON.
Флаги объектов:
| Значение | Описание |
|---|---|
| 0x00000001 | базовый флаг |
| 0x00000002 | произвольные свойства |
| 0x00000004 | свойства биллинга |
| 0x00000008 | произвольные поля |
| 0x00000010 | изображение |
| 0x00000020 | сообщения |
| 0x00000040 | GUID |
| 0x00000080 | административные записи |
| 0x00000100 | дополнительные свойства |
| 0x00000200 | доступные в данный момент команды |
| 0x00000400 | последнее сообщение и местоположение |
| 0x00001000 | датчики |
| 0x00002000 | счетчики |
| 0x00008000 | техобслуживание |
| 0x00020000 | конфигурация объекта в отчетах: детектор поездок и расход топлива |
| 0x00080000 | список всех возможных команд |
| 0x00100000 | параметры сообщений |
| 0x00400000 | местоположение |
| 0x3FFFFFFFFFFFFFFF | устанавливает все возможные флаги для объекта |
Флаг - 0x00000001
{ "mu":<uint>, /* единицы измерения: 0 - si, 1 - us, 2 - имперская */ "nm":<text>, /* название */ "cls":<uint>, /* ID базового класса "avl_unit" */ "id":<uint>, /* ID объекта */ "uacl":<uint> /* уровень доступа к объекту у текущего пользователя */ }
Флаг - 0x00000002
В произвольных свойствах вы можете сохранять любые нужные вам данные об объекте.
{ "prp":{ /* произвольные свойства */ "dehr":<text>, /* суточная норма моточасов, секунд */ "img_rot":<text>, /* поворачивать иконки объектов: "1" - да, "0" - нет */ "mcoef":<text>, /* коэффициент пробега */ "mmi":<text>, /* максимальный интервал между сообщениями в секундах */ "monitoring_sensor":<text>, /* таблица цветов трека по датчику */ "monitoring_sensor_id":<text>, /* ID датчика, который будет отображаться в панели мониторинга */ "msl":<text>, /* ограничение скорости, км/ч */ "mus":<text>, /* предел скорости в городе, км/ч */ "sensors_colors_id":<text>, /* ID датчика, по которому будет отображаться цвет датчика */ ... }, "ct":<uint> /* дата создания */ }
Флаг - 0x00000004
{ "crt":<uint>, /* ID создателя */ "bact":<uint> /* ID учетной записи */ }
Флаг - 0x00000008
{ "flds":{ /* список произвольных полей */ <text>:{ /* порядковый номер произвольного поля */ "id":<uint>, /* ID */ "n":<text>, /* имя */ "v":<text> /* значение */ }, ... }, "fldsmax":<long>, /* максимальное количество произвольных полей (-1 - не ограничено) */ }
Флаг - 0x00000010
{ "ugi":<uint> /* счетчик изменений изображения */ }
Флаг - 0x00000020
Установка данного флага позволяет принимать сообщения от объекта.
{}
Флаг - 0x00000040
{ "gd":<text> /* GUID объекта */ }
Flag - 0x00000080
{ "aflds":{ /* административные записи */ <text>:{ /* порядковый номер */ "id":<uint>, /* ID */ "n":<text>, /* название */ "v":<text> /* значение */ }, ... }, "afldsmax":<long>, /* максимально допустимое количество административных записей (-1 - не ограничено) */ }
Флаг - 0x00000100
{ "uid":<text>, /* уникальный ID оборудования */ "hw":<long>, /* тип оборудования */ "ph":<text>, /* телефонный номер */ "ph2":<text>, /* второй телефонный номер */ "psw":<text> /* пароль */ }
Флаг - 0x00000200
{ "cmds":[ /* массив команд */ { "n":<text>, /* название команды */ "a":<uint>, /* уровень доступа */ "t":<text>, /* тип связи */ "c":<text> /* тип команды */ } ] }
Типы команд и связи рассмотрены в разделе Команды: cоздание, редактирование и удаление, а список флагов доступа к объекту можно посмотреть в разделах Флаги доступа: Общие и Флаги доступа: Объекты и группы объектов.
Флаг - 0x00000400
{ "pos":{ /* последнее известное местоположение */ "t":<uint>, /* время UTC */ "y":<double>, /* широта */ "x":<double>, /* долгота */ "z":<double>, /* высота над уровнем моря */ "s":<int>, /* скорость */ "c":<int>, /* курс */ "sc":<int> /* спутники */ }, "lmsg":{ /* последнее известное сообщение */ ... } }
Формат последнего сообщения зависит от его типа, все типы рассмотрены в разделе Форматы данных: Сообщения.
Флаг - 0x00001000
{ "sens":{ /* датчики */ <text>:{ /* номер датчика */ "id":<long>, /* ID */ "n":<text>, /* название */ "t":<text>, /* тип */ "d":<text>, /* описание */ "m":<text>, /* единица измерения */ "p":<text>, /* параметр */ "f":<uint>, /* флаги датчика */ "c":<text>, /* конфигурация */ "vt":<uint>, /* тип валидации */ "vs":<uint>, /* ID валидирующего датчика */ "tbl":[ /* таблица расчета */ { /* параметры */ "x":<double>, "a":<double>, "b":<double> } ] }, ... }, "sens_max":<long> /* количество датчиков, разрешенное тарифным планом (-1 - не ограничено) */ }
Флаги датчика, типы датчиков и валидации, а также примеры конфигурации рассмотрены в разделе Датчики: создание, редактирование и удаление.
Флаг - 0x00002000
{ "cfl":<uint>, /* флаги калькуляции */ "cnm":<uint>, /* счетчик пробега, км или мили */ "cneh":<uint>, /* счетчик моточасов, ч */ "cnkb":<uint> /* счетчик GPRS-трафика, Кб */ }
Флаги калькуляции рассмотрены в разделе Параметры калькуляции счетчиков.
Флаг - 0x00008000
{ "si":{ /*записи о техобслуживании*/ <text>:{ /* порядковый номер */ "id":<uint>, /* ID */ "n":<text>, /* название */ "t":<text>, /* описание */ "im":<uint>, /* интервал по пробегу */ "it":<uint>, /* интервал в днях */ "ie":<uint>, /* интервал по моточасам */ "pm":<uint>, /* последнее техобслуживание для интервала по пробегу, км */ "pt":<uint>, /* последнее техобслуживание для интервала в днях (дата в секундах) */ "pe":<uint>, /* последнее техобслуживание для интервала по моточасам, ч */ "c":<uint> /* количество выполнений */ }, ... }, "simax":<long> /* количество записей, разрешенное тарифным планом (-1 - не ограничено) */ }
Флаг - 0x00020000
{ "rtd":{ /* детектор поездок */ "type":<uint>, /* тип определения движения */ "gpsCorrection":<int>, /* коррекция по GPS: 0 - выключить, 1 - включить */ "minSat":<uint>, /* минимальное количество спутников */ "minMovingSpeed":<uint>, /* минимальная скорость движения, км/ч */ "minStayTime":<uint>, /* минимальное время стоянки, секунд */ "maxMessagesDistance":<uint>, /* максимальное расстояние между сообщениями, метров */ "minTripTime":<uint>, /* минимальное время поездки, секунд */ "minTripDistance":<uint> /* минимальное расстояние поездки, метров */ }, "rfc":{ /* расход топлива */ "calcTypes":<uint>, /* тип расчета */ "fuelLevelParams":{ /* определение заправок/сливов топлива */ "flags":<uint>, /* флаги заправки/слива топлива */ "ignoreStayTimeout":<uint>, /* игнорировать сообщения после начала движения, секунд */ "minFillingVolume":<uint>, /* минимальный объем заправки, литров */ "minTheftTimeout":<uint>, /* минимальное время остановки для определения слива, секунд */ "minTheftVolume":<uint>, /* минимальный объем слива, литров */ "filterQuality":<int> /* степень фильтрации (0..255) */ }, "fuelConsMath":{ /* расход по расчету */ "idling":<double>, /* на холостом ходу, литров в час */ "urban":<double>, /* городской цикл, литров на 100 км */ "suburban":<double>, /* загородный цикл, литров на 100 км */ "loadCoef":<double> /* коэффициент при движении под загрузкой */ }, "fuelConsRates":{ /* расход по нормам */ "consSummer":<int>, /* расход летом, литров на 100 км */ "consWinter":<int>, /* расход зимой, литров на 100 км */ "winterMonthFrom":<int>, /* зима от (месяц 0-11) */ "winterDayFrom":<int>, /* зима от (день 1-31) */ "winterMonthTo":<int>, /* зима до (месяц 0-11) */ "winterDayTo":<int> /* зима до (день 1-31) */ }, "fuelConsImpulse":{ /* импульсные датчики расхода топлива */ "maxImpulses":<int>, /* максимум импульсов */ "skipZero":<int> /* пропускать начальные нулевые значения */ } } }
Типы определения движения рассмотрены в разделе Детектор поездок, а типы расчета расхода топлива и флаги заправки и слива можно посмотреть в разделе Расход топлива.
Флаг - 0x00080000
{ "cml":{ /* список команд */ <text>:{ /* порядковый номер команды */ "id":<uint>, /* ID */ "n":<text>, /* названиe */ "c":<text>, /* тип */ "l":<text>, /* тип связи */ "p":<text>, /* параметры */ "a":<uint>, /* уровень доступа (права, которыми должен обладать пользователь, чтобы выполнить данную команду) */ "f":<uint> /* отправлять на номер: 0-любой (первичный, затем вторичный), 0x1-первичный, 0x2-вторичный */ }, ... }, "cml_max":<long> /* максимальное количество команд, разрешенное тарифным планом (-1 - не ограничено) */ }
Типы команд и связи рассмотрены в разделе Команды: cоздание, редактирование и удаление, а список флагов доступа к объекту можно посмотреть в разделах Флаги доступа: Общие и Флаги доступа: Объекты и группы объектов.
Позволяет ипользовать накопительную систему значений параметров сообщений. Параметры будут сохранятся в соответствующем разделе JSON объекта, в котором будут хранится значения не только параметров, присутствующих в последнем сообщении, но и значения параметров из более ранних сообщений.
Flag - 0x00100000
{ "prms":{ /* список параметров сообщений */ <text>:{ /* имя параметра */ "v":<any>, /*значение параметра */ "ct":<uint>, /* время последнего изменения значения */ "at":<uint> /* время последнего сообщения, содержащего данный параметр */ }, ... } }
Флаг - 0x00400000
{ "pos":{ /* последнее известное местоположение */ "t":<uint>, /* время UTC */ "y":<double>, /* широта */ "x":<double>, /* долгота */ "z":<double>, /* высота над уровнем моря */ "s":<int>, /* скорость */ "c":<int>, /* курс */ "sc":<int> /* спутники */ } }
|
