Пользователи
В зависимости от указанных флагов формат ответа может различаться. В этом разделе описаны флаги, которые можно применять к пользователям. Также подробно описываются части ответа, которые содержат информацию о флагах. Если указано несколько флагов, их соответствующие части объединяются в один 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 | Мобильные приложения пользователя |
0x3FFFFFFFFFFFFFFF | 4611686018427387903 | Установить все флаги пользователя |
Основные свойства
Флаг основных свойств - 0x00000001.
{
"nm": "<text>", /* Имя пользователя */
"cls": <uint>, /* ID базового класса: "user" */
"id": <uint>, /* ID пользователя */
"mu": <uint>, /* Система измерений:
0 - СИ,
1 - американская,
2 - имперская,
3 - метрическая с галлонами */
"uacl": <uint> /* Права доступа пользователя на этого пользователя */
}
Произвольные свойства
Флаг пользовательских свойств - 0x00000002.
В пользовательских свойствах можно хранить любые данные пользователя. Обычно это такие настройки, как email пользователя, позиция карты после входа в систему и т.д.
{
"prp": {
"cfmt": "<text>", /* Формат координат: 0 - градусы и минуты, 1 - градусы */
"email": "<text>", /* Email пользователя */
"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.
После установки этого флага можно получать сообщения от объекта.
{}
GUID
Флаг GUID - 0x00000040.
{
"gd": <text> /* GUID пользователя */
}
Административные поля
Флаг административных полей - 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> /* Тип двухфакторной аутентификации */
}
}
Флаги настроек пользователя перечислены на странице update_user_flags.
Уведомления
Флаг уведомлений - 0x00000200.
{
"usnf": { /* Уведомления пользователя */
"<text>": { /* Порядковый номер */
"id": <long>, /* ID */
"t": <uint>, /* Время жизни (в секундах) */
"d": "<text>", /* Текст уведомления */
"h": "<text>", /* Тема */
"s": "<text>" /* Отправитель */
}
}
}
Флаги мобильных приложений пользователя
Флаг мобильных приложений пользователя - 0x00000800.
{
"mobile_apps": <text>,
}