ПланФикс API: Сотрудники
Материал из Planfix
Функции управления своим личным профилем, управление профилем сотрудников.
- user.add / Создать нового сотрудника
- user.update / Обновить данные пользователя
- user.get / Получить информацию о пользователе
- user.getList / Список пользователей
- user.updateGroupMembership / Именить принадлежность к группе
- user.changeStatus / Изменить/установить статус пользователя
user.updateGroupMembership Именить принадлежность к группе
Запрос:
<?xml version="1.0" encoding="UTF-8"?>
<request method="user.updateGroupMembership ">
<account><!-- имя аккаунта --></account>
<sid><!-- ключ сессии, полученный после аутентификации --></sid>
<status></status>
<user>
<id></id>
<userGroup>
<id></id>
<id></id>
<!-- ... -->
</userGroup>
</user>
<signature></signature>
</request>
Для того чтоб исключить пользователя из всех групп, достаточно передать список userGroup пустым.
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<user>
<id></id>
</user>
</response>
user.changeStatus Изменить/установить статус пользователя
Позволяет установить статус, если передан/задан параметр status. Если параметр опущен, то статус будет поменян на противоположный установленному. Запрос:
<?xml version="1.0" encoding="UTF-8"?>
<request method="user.changeStatus">
<account><!-- имя аккаунта --></account>
<sid><!-- ключ сессии, полученный после аутентификации --></sid>
<status></status>
<user>
<id></id>
<status><!-- не обязательное поле --></status>
</user>
<signature></signature>
</request>
В ответе будет передан параметр статус с указанием установленного статуса. Пакет ответа:
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<user>
<id></id>
</user>
</response>
Константы
Роли пользователей
- ADMIN - Администратор
- USER - Пользователь
- AUDITOR - Аудитор
Пол
- MALE - муской пол
- FEMALE - женский пол
Типы сортировок
- NAME_ASC - по имени (алфавит)
- NAME_DESC - по имени (обратный порядок)
- GROUP_ASC - по имени группы (алфавит)
- GROUP_DESC - по имени группы (обратный порядок)
- ISACTIVE_ASC - неактивные, потом активные
- ISACTIVE_DESC - активные, потом неактивные
- PROJECTS_ASC - по проекту (алфавит)
- PROJECTS_DESC - по проекту (обратный порядок)
- ROLE_ASC - роль (возрастание)
- ROLE_DESC - роль (убывание)