|
|
ru:pro:remoteapi:apiref:core:login [13/01/2014 10:40] zuve |
ru:pro:remoteapi:apiref:core:login [13/01/2014 11:40] |
{{indexmenu_n>1}} | |
====== Логин ====== | |
| |
Для того, чтобы начать работу с Wialon Pro, необходимо сначала выполнить вход. Для этого используется команда **core/login**: | |
| |
<code javascript> | |
svc=core/login¶ms={"user":<text>, | |
"password":<text>} | |
</code> | |
| |
:!: После входа создается сессия, в пределах которой могут быть выполнены различные запросы. Если в течении 10 минут сервер не получит ни одного запроса, то он оборвет сессию. | |
| |
:!: Использование данного запроса рассмотрено в примере [[../../codesamples/login]]. | |
| |
===== Параметры ===== | |
| |
^ Название ^ Описание ^ | |
| user | имя пользователя | | |
| password | пароль | | |
| |
===== Возвращаемый результат ===== | |
<code javascript> | |
{ | |
"uid":<long>, /* ID пользователя*/ | |
"eid":<long>, /* количество логинов данного пользователя */ | |
"ssid":<text> /* ID сессии*/ | |
"pi":<int>, /* интервал пинга */ | |
"tm":<uint>, /* текущее время (UTC) */ | |
"user": { /* пользователь */ | |
"nm":<text>, /* имя */ | |
"cls":<uint>, /* ID базового класса "user" */ | |
"id":<long>, /* ID */ | |
"gd":<text>, /* GUID */ | |
"prp": { /* произвольные свойства */ | |
<text>:<text>, /* название свойства: значение */ | |
... | |
}, | |
"pup": { /* частные и публичные свойства */ | |
<text>:<text>, /* название свойства: значение */ | |
... | |
}, | |
"crt":<uint>, /* ID создателя */ | |
"bact":<uint>, /* ID учетной записи */ | |
"fl":<uint>, /* флаги пользователя */ | |
"usnf":{ /* уведомления пользователя */ | |
<text>:{ /* порядковый номер уведомления */ | |
"t":<uint>, /* время хранения (сек) */ | |
"d":<text>, /* описание */ | |
"h":<text>, /* заголовок */ | |
"s":<text> /* отправитель */ | |
}, | |
... | |
}, | |
"smsp":<text> /* номера телефонов пользователя через запятую */ | |
}, | |
"classes": { /* базовые классы доступные текущему пользователю: ключ - название базового класса, значение - ID базового класса */ | |
"avl_hw":<uint>, /* тип оборудования */ | |
"avl_resource":<uint>, /* ресурс */ | |
"avl_retranslator":<uint>, /* ретранслятор */ | |
"avl_unit":<uint>, /* объект */ | |
"avl_unit_group":<uint>, /* группа объектов */ | |
"user":<uint> /* пользователь */ | |
} | |
} | |
</code> | |
| |
Флаги пользователя рассмотрены в разделе [[../user/update_user_flags]]. | |
| |
===== Возможные ошибки ===== | |
| |
^ Код ^ Значение ^ | |
| 1 | недействительная сессия | | |
| 2 | неверное имя сервиса | | |
| 3 | неверный результат | | |
| 4 | неверный формат или значение параметров | | |
| 6 | сервер недоступен | | |
| 8 | неверный пароль или имя пользователя | | |