ПланФикс API user.update
Материал из ПланФикс
Версия от 08:15, 24 августа 2010; Seva (обсуждение | вклад) (Новая страница: «Функция обновления данных пользователя. Формат запроса: <source lang="xml"> <?xml version="1.0" encoding="UTF-8"?> <r...»)
Функция обновления данных пользователя. Формат запроса:
<?xml version="1.0" encoding="UTF-8"?>
<request method="user.update">
<account></account>
<sid></sid>
<user>
<id></id>
<name></name>
<lastName></lastName>
<email></email>
<role></role>
<status></status>
<password></password>
<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>
</user>
<signature></signature>
</request>
Название | Тип | Значение | Примечание |
---|---|---|---|
id | int | ||
name | string | имя, отчество пользователя | необязательное поле |
lastName | string | фамилия пользователя | необязательное поле |
string | электронный адрес почты | необязательное поле | |
role | enum | роль пользователя в системе | необязательное поле. доступно для изменения только пользователям с правами администратор |
status | enum | статус | необязательное поле. доступно для изменения только пользователям с правами администратор |
password | string | пароль | необязательное поле |
notify | уведомления | необязательное поле | |
notify.byEmail | bool | получать уведомления по электронной почте | необязательное поле |
notify.byJabber | bool | получать уведомления по jabber | необязательное поле |
notify.byPlanfix | bool | получать уведомления по внутренней системе уведомлений ПланФикс | необязательное поле |
birthdate | DateTime | дата рождения | необязательное поле |
sex | enum | пол сотрудника | необязательное поле. список допустимых значений смотри в разделе ПланФикс API:Пол сотрудника:пол сотрудника |
phone | string | телефон | необязательное поле |
coeff | float | личный коэффициент | необязательное поле. доступно для изменения только пользователям с правами администратор |
timezone | int | часовой пояс | необязательное поле |
useDst | bool | переход на летнее время | необязательное поле |
isInvisibleOutOfGroup | bool | true=Видит только членов своих групп; false=Видит всех сотрудников | необязательное поле. доступно для изменения только пользователям с правами администратор |
isBlindOutOfGroup | bool | true=Его видят только члены его групп; false=Его видят все сотрудники | необязательное поле. доступно для изменения только пользователям с правами администратор |
userPic | string | base64 закодированная картинка | необязательное поле |
Результат успешного выполнения функции:
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<user>
<id></id>
</user>
</response>
Название | Тип | Значение | Примечание |
---|---|---|---|
user.id | int | идентификатор обновляемого пользователя |
В противном случае будет возвращен ответ с ошибкой:
<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
<code></code>
</response>
Значение code | Расшифровка |
---|---|
0000 | неизвестная ошибка |