ПланФикс API: Сотрудники
Материал из Planfix
Управление своим личным профилем, управление профилем сотрудников.
user.add Создать нового сотрудника
Выполнение данной функции разрешено пользователю с админ правами.
<?xml version="1.0" encoding="UTF-8"?>
<request method="user.add">
<account><!-- имя аккаунта --></account>
<sid><!-- ключ сессии, полученный после аутентификации --></sid>
<user>
<name>Имя Отчество</name>
<lastName>Фамилия</lastName>
<email></email>
<role></role>
<status></status>
</user>
<signature></signature>
</request>
Допустимые значения для поля role - ADMIN, USER
Ответ:
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<user>
<id></id>
<isActivated>{true|false}</isActivated>
</user>
</response>
Поле isActivated - в принципе будет равно false, т.к. пользователь навряд ли будет активирован на этот момент.
user.update Обновить данные пользователя
Запрос на обновление данных пользователя.
<?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>Получать уведомления по jabber</byJabber>
<byPlanfix>Получать уведомления по внутренней системе уведомлений ПланФикс</byPlanfix>
</notify>
<birthdate>дата рождения</birthdate>
<sex>пол</sex>
<phone></phone>
<coeff>личный коэффициент</coeff>
<timezone>Часовой пояс</timezone>
<useDst>{true|false}</useDst><!-- Переход на летнее время -->
<isInvisibleOutOfGroup>{true|false}</isInvisibleOutOfGroup>
<isBlindOutOfGroup>{true|false}</isBlindOutOfGroup>
<userPic></userPic>
</user>
<signature></signature>
</request>
Поля, кроме id, необязательные, если они не переданы в запросе - они не изменяются. Поля role, status доступны для изменения только администратором.
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<user>
<id></id>
</user>
</response>
user.get Получить информацию о пользователе
user.getList Список пользователей
Константы
Роли пользователей
- ADMIN - Администратор
- USER - Пользователь
- AUDITOR - Аудитор
Пол
- MALE - муской пол
- FEMALE - женский пол