ПланФикс API user.get: различия между версиями
Материал из Planfix
Alice (обсуждение | вклад) Нет описания правки |
Seva (обсуждение | вклад) Нет описания правки |
||
Строка 37: | Строка 37: | ||
<login></login> | <login></login> | ||
<email></email> | <email></email> | ||
<secondaryEmails> | |||
<email></email> | |||
<!-- ... --> | |||
</secondaryEmails> | |||
<jabber></jabber> | <jabber></jabber> | ||
<role></role> | <role></role> | ||
Строка 85: | Строка 89: | ||
|- | |- | ||
|email || string|| электронный адрес почты|| | |email || string|| электронный адрес почты|| | ||
|- | |||
|secondaryEmails.email || || дополнительные адреса email, если есть|| | |||
|- | |- | ||
|jabber || string|| jabber-аккаунт || | |jabber || string|| jabber-аккаунт || |
Версия от 11:44, 7 апреля 2018
Функция получения информации о пользователе. Формат запроса:
<?xml version="1.0" encoding="UTF-8"?>
<request method="user.get">
<account></account>
<sid></sid>
<user>
<id></id>
</user>
<signature></signature>
</request>
Название | Тип | Значение | Примечание |
---|---|---|---|
user.id | int | идентификатор пользователя | при отсутствии данного параметра, возвращаются данные сотрудника, от которого происходит запрос |
signature | string(32) | подпись |
Ответ:
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<user>
<id></id>
<name></name>
<lastName></lastName>
<login></login>
<email></email>
<secondaryEmails>
<email></email>
<!-- ... -->
</secondaryEmails>
<jabber></jabber>
<role></role>
<status></status>
<notify>
<byEmail></byEmail>
<byJabber></byJabber>
<byPlanfix></byPlanfix>
</notify>
<birthdate></birthdate>
<sex></sex>
<phone></phone>
<coeff></coeff>
<timezone></timezone>
<useDst></useDst>
<isInvisibleOutOfGroup></isInvisibleOutOfGroup>
<isBlindOutOfGroup></isBlindOutOfGroup>
<userPic></userPic>
<isOnline></isOnline>
<post>
<id></id>
<name></name>
</post>
<userGroups>
<userGroup>
<id></id>
<name></name>
</userGroup>
<userGroup>
<id></id>
<name></name>
</userGroup>
<!-- ... -->
</userGroups>
</user>
</response>
Название | Тип | Значение | Примечание |
---|---|---|---|
id | int | ||
name | string | имя, отчество пользователя | |
lastName | string | фамилия пользователя | |
login | string | имя учетной записи в системе | |
string | электронный адрес почты | ||
secondaryEmails.email | дополнительные адреса email, если есть | ||
jabber | string | jabber-аккаунт | |
role | enum | роль пользователя в системе | |
status | enum | статус | список допустимых значений смотри в разделе статусы пользователей |
notify | уведомления | ||
notify.byEmail | bool | получать уведомления по электронной почте | |
notify.byJabber | bool | получать уведомления по jabber | |
notify.byPlanfix | bool | получать уведомления по внутренней системе уведомлений ПланФикс | |
birthdate | DateTime | дата рождения | если значение не установлено, то значение пусто |
sex | enum | пол сотрудника | список допустимых значений смотри в разделе пол сотрудника, если значение не установлено, то значение пусто |
phone | string | телефон | |
coeff | float | личный коэффициент | доступно для пользователей с правами администратор |
timezone | string | часовой пояс | |
useDst | bool | переход на летнее время | |
isInvisibleOutOfGroup | bool | true=Видит только членов своих групп; false=Видит всех сотрудников | доступно для пользователей с правами администратор |
isBlindOutOfGroup | bool | true=Его видят только члены его групп; false=Его видят все сотрудники | доступно для пользователей с правами администратор |
userPic | string | возвращает полный URL к картинке | если не установлен - узел пустой |
post | должность пользователя | ||
post.id | int | идентификатор должности | |
post.name | string | название должности | |
userGroups | список групп в которых состоит пользователь | ||
userGroups.userGroup | группа | ||
userGroups.userGroup.id | int | идентификатор группы | |
userGroups.userGroup.name | string | название группы |
В противном случае будет возвращен ответ с ошибкой:
<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
<code></code>
</response>