Справочный центр Wialon

Пользователи

В зависимости от указанных флагов формат ответа может различаться.

На этой странице описаны флаги, которые можно применять к пользователям, и соответствующие им части результирующего JSON, которыми они управляют. Если указано несколько флагов, их соответствующие части объединяются в единый JSON.

Флаги пользователя

К пользователям можно применить следующие флаги:

Значение в HEX Значение в DEC Описание
0x00000001 1 Основные свойства (базовый флаг)
0x00000002 2 Произвольные свойства
0x00000004 4 Информация о биллинге
0x00000008 8 Произвольные поля
0x00000020 32 Сообщения (только подписка)
0x00000040 64 GUID
0x00000080 128 Административные поля
0x00000100 256 Прочие свойства пользователя, включая маску хоста
0x00000200 512 Уведомления
0x00000800 2048 Мобильные приложения пользователя
0x3FFFFFFFFFFFFFFF 4611686018427387903 Установить все флаги пользователя

Основные свойства

Флаг основных свойств — 0x00000001 (1).

Copied!
{
	"nm": "<text>",  /* Имя пользователя */
	"cls": <uint>,  /* ID суперкласса user, обычно 1 (см. ключ classes в ответе token/login) */
	"id": <uint>,  /* ID пользователя */
	"mu": <uint>,  /* Система измерений:
		0 - СИ,
		1 - американская,
		2 - имперская,
		3 - метрическая с галлонами */
	"uacl": <long>  /* Права доступа пользователя на этого пользователя (64-битное значение) */
}

Произвольные свойства

Флаг произвольных свойств — 0x00000002 (2).

Объект prp содержит произвольные свойства, которые интерфейс Wialon и приложения сохраняют для пользователя, поэтому набор ключей может различаться. Некоторые из ключей приведены ниже в качестве примера.

Copied!
{
	"prp": {
		"tz": "<text>",     /* Часовой пояс, см. Пример получения параметра tz */
		"language": "<text>", /* Язык интерфейса */
		"cfmt": "<text>",   /* Формат координат: 0 - градусы и минуты, 1 - градусы */
		"email": "<text>",  /* Email пользователя */
		"msc": "<text>",    /* Позиция карты после входа: 0 - по умолчанию, 1 - сохраненная */
		"poisrv": "<text>"  /* Отрисовка POI на сервере */
	},
	"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 — нет */
	},
	"ct": <uint>	/* Время создания (Unix-время) */
}

Информация о биллинге

Флаг информации о биллинге — 0x00000004 (4).

Copied!
{
	"crt": <uint>,	/* ID создателя */
	"bact": <uint>	/* ID учетной записи */
}

Произвольные поля

Флаг произвольных полей — 0x00000008 (8).

Copied!
{
	"flds": {               /* Произвольные поля */
		"<text>": {         /* ID произвольного поля */
			"id": <uint>,   /* ID */
			"n": "<text>",  /* Название */
			"v": "<text>",  /* Значение */
			"ct": <uint>,   /* Время создания (Unix-время) */
			"mt": <uint>    /* Время последнего изменения (Unix-время) */
		}
	},
	"fldsmax": <long> /* Максимальное количество произвольных полей, разрешенное тарифным планом учетной записи (-1 для неограниченного количества). Может быть равно 0, если услуги нет в тарифном плане; существующие произвольные поля при этом все равно возвращаются */
}

Сообщения

Флаг сообщений — 0x00000020 (32).

Этот флаг не добавляет данные в ответ. Он подписывает сессию на новые сообщения пользователя.

Чтобы использовать этот флаг, установите его для пользователя с помощью метода core/update_data_flags. После этого каждое новое сообщение, зарегистрированное для пользователя, передается как событие в avl_evts. Типы сообщений и их формат описаны на странице Сообщения.

Этот флаг рекомендуется комбинировать с флагом основных свойств 0x00000001 (1). Если использовать флаг сообщений отдельно, метод core/update_data_flags возвращает пустой объект d, из-за чего может показаться, что подписка не сработала.

GUID

Флаг GUID — 0x00000040 (64).

Copied!
{
	"gd": "<text>"	/* GUID пользователя */
}

Административные поля

Флаг административных полей — 0x00000080 (128).

Copied!
{
	"aflds": { /* Административные поля */		
		"<text>": { /* ID административного поля */
			"id": <uint>, /* ID */
			"n": "<text>", /* Название */
			"v": "<text>", /* Значение */
			"ct": <uint>, /* Время создания (Unix-время) */
			"mt": <uint> /* Время последнего изменения (Unix-время) */
		},
		...
	},
	"afldsmax": <long>	/* Максимальное количество административных полей, разрешенное тарифным планом учетной записи (-1 для неограниченного количества). Может быть равно 0, если услуги нет в тарифном плане; существующие административные поля при этом все равно возвращаются */
}

Прочие свойства пользователя

Флаг прочих свойств пользователя — 0x00000100 (256).

Copied!
{
	"fl": <uint>, /* Флаги настроек пользователя */
	"hm": "<text>", /* Маска хоста */
	"ld": <uint>, /* Время последнего входа */
	"pfl": <uint>, /* Флаги, разрешенные родительскими учетными записями */
	"ap": {         /* Параметры аутентификации. Отсутствуют, если не заданы */
	    "type": <uint>,   /* Тип двухфакторной аутентификации: 0 — нет, 1 — email, 2 — SMS */
	    "phone": "<text>", /* Номер телефона для двухфакторной аутентификации */
	    "gmail": "<text>"  /* Email подключенного сервиса аутентификации */
	}
}

Флаги настроек пользователя перечислены на странице user/update_user_flags. В значении pfl используются те же флаги: оно содержит флаги, установленные для всех родительских учетных записей пользователя вверх по иерархии.

Объект ap возвращается, только если параметры аутентификации заданы с помощью метода user/update_auth_params или user/bind_auth_service. Название ключа сервиса аутентификации зависит от сервиса, например gmail.

Уведомления

Флаг уведомлений — 0x00000200 (512).

Copied!
{
	"usnf": {  /* Уведомления пользователя */
		"<text>": {  /* ID уведомления */
			"id": <long>,  /* ID */
			"t": <uint>,  /* Время жизни (в секундах) */
			"d": "<text>",  /* Текст уведомления */
			"h": "<text>",  /* Тема */
			"s": "<text>",  /* Отправитель */
			"ct": <uint>,  /* Время создания (Unix-время) */
			"mt": <uint>  /* Время последнего изменения (Unix-время) */
		}
	}
}

Мобильные приложения пользователя

Флаг мобильных приложений пользователя — 0x00000800 (2048).

Copied!
{
	"mapps": {          /* Мобильные приложения */
		"<text>": {         /* ID мобильного приложения */
			"id": <long>,   /* ID */
			"n": "<text>",  /* Имя */
			"uid": "<text>", /* Токен устройства для push-уведомлений */
			"cp": {},       /* Произвольные параметры, заданные мобильным приложением */
			"as": {},       /* Спецификация приложения, заданная мобильным приложением */
			"e": <uint>,    /* Включено: 1 — да, 0 — нет */
			"ct": <uint>,   /* Время создания (Unix-время) */
			"mt": <uint>    /* Время последнего изменения (Unix-время) */
		}
	},
	"mappsmax": <long>  /* Максимальное количество мобильных приложений, разрешенное тарифным планом учетной записи (-1 для неограниченного количества). Может быть равно 0, если услуги нет в тарифном плане; существующие мобильные приложения при этом все равно возвращаются */
}

Ключ mapps требует права доступа Просмотр подробных свойств к пользователю, а mappsmax — права Выполнение действий от имени пользователя.

Если вы заметили ошибку в тексте, пожалуйста, выделите её и нажмите Ctrl+Enter.