В зависимости от установленных флагов формат ответа может варьироваться.
В данном разделе рассмотрены флаги, применимые к пользователям, и части результирующего JSON, за которые они отвечают. При указании нескольких флагов части будут собираться в один JSON.
Все флаги используются только в DEC формате.
Флаги пользователей:
Значение HEX | Значение DEC | Описание |
---|---|---|
0x00000001 | 1 | базовый флаг |
0x00000002 | 2 | произвольные свойства |
0x00000004 | 4 | свойства биллинга |
0x00000008 | 8 | произвольные поля |
0x00000020 | 32 | сообщения |
0x00000040 | 64 | GUID |
0x00000080 | 128 | административные записи |
0x00000100 | 256 | другие свойства |
0x00000200 | 512 | уведомления |
0x3FFFFFFFFFFFFFFF | 4611686018427387903 | устанавливает все возможные флаги для пользователя |
Флаг - 0x00000001
{ "nm":<text>, /* имя пользователя */ "cls":<uint>, /* ID базового класса "user" */ "id":<uint>, /* ID пользователя */ "mu":<uint>, /* единицы измерения: 0 - si, 1 - us, 2 - имперская, 3 - метрическая с галлонами */ "uacl":<uint> /* уровень доступа к запрашиваемому пользователю у текущего пользователя*/ }
Флаг - 0x00000002
В произвольных свойствах вы можете сохранять любые нужные вам данные о пользователе. Обычно это настройки, такие как: e-mail пользователя, отрисовывать POI на сервере, позиция карты при старте и т.д.
{ "prp":{ "cfmt":<text>, /* формат координат: "0" - градусы и минуты, "1" - градусы */ "email":<text>, /* e-mail пользователя */ "msc":<text>, /* позиция карты при старте: "0" - по умолчанию, "1" - сохраненная */ "poisrv":<text>, /* отрисовывать POI на сервере */ ... } }
Флаг - 0x00000004
{ "crt":<uint>, /* ID создателя */ "bact":<uint> /* ID учетной записи */ }
Флаг - 0x00000008
{ "flds":{ /* произвольные поля */ <text>:{ /* порядковый номер произвольного поля */ "id":<uint>, /* ID */ "n":<text>, /* название */ "v":<text> /* значение */ }, ... }, "fldsmax":<long> /* максимальное количество произвольных полей (-1 - не ограничено) */ }
Флаг - 0x00000020
Установка данного флага позволяет принимать сообщения от пользователя.
{}
Флаг - 0x00000040
{ "gd":<text> /* GUID пользователя */ }
Flag - 0x00000080
{ "aflds":{ /* административные записи */ <text>:{ /* порядковый номер */ "id":<uint>, /* ID */ "n":<text>, /* название */ "v":<text> /* значение */ }, ... }, "afldsmax":<long>, /* максимально допустимое количество административных записей (-1 - не ограничено) */ }
Флаг - 0x00000100
{ "fl":<uint>, /* флаги настроек пользователя*/ "hm":<text>, /* маска хоста */ "ld":<uint>, /* время последнего логина */ "pfl":<uint>, /* родительские флаги */ "ap":{ "type":<uint>, /* тип двухфакторной авторизации */ "phone":<text> /* номер телефона для двухфакторной авторизации */ } }
Флаги настроек рассмотрены в разделе Установить флаги настроек пользователя.
Флаг - 0x00000200
{ "usnf":{ /* уведомления пользователя */ <text>:{ /* порядковый номер уведомления */ "id":<long>, /* ID */ "t":<uint>, /* время хранения (сек) */ "d":<text>, /* описание */ "h":<text>, /* заголовок */ "s":<text> /* отправитель */ }, ... } }