|
|
| (не показано 14 промежуточных версий 3 участников) |
| Строка 1: |
Строка 1: |
| Управление своим личным профилем, управление профилем сотрудников.
| | {{#seo: |
| | |title=ПланФикс API: Сотрудники |
| | |titlemode=append |
| | |keywords=планфикс, сотрудники, апи, api |
| | |description=сотрудники api |
| | }} |
|
| |
|
| == user.add Создать нового сотрудника ==
| | Функции управления своим личным профилем, управление профилем сотрудников. |
| Выполнение данной функции разрешено пользователю с админ правами.
| | #[[ПланФикс API user.add|user.add / Создать нового сотрудника]] |
| <source lang="xml">
| | #[[ПланФикс API user.update|user.update / Обновить данные пользователя]] |
| <?xml version="1.0" encoding="UTF-8"?>
| | #[[ПланФикс API user.get|user.get / Получить информацию о пользователе]] |
| <request method="user.add">
| | #[[ПланФикс API user.getList|user.getList / Список пользователей]] |
| <account><!-- имя аккаунта --></account>
| | #[[ПланФикс API user.updateGroupMembership|user.updateGroupMembership / Изменить принадлежность к группе]] |
| <sid><!-- ключ сессии, полученный после аутентификации --></sid>
| | #[[ПланФикс API user.changeStatus|user.changeStatus / Изменить/установить статус пользователя]] |
| <user>
| | #[[ПланФикс API user.actionsAdded|user.actionsAdded / Получить количество добавленных пользователем действий за период]] |
| <name>Имя Отчество</name>
| |
| <lastName>Фамилия</lastName>
| |
| <email></email>
| |
| <role></role>
| |
| <status></status>
| |
| </user>
| |
| <signature></signature>
| |
| </request>
| |
| </source>
| |
| Допустимые значения для поля '''role''' - ''ADMIN'', ''USER''
| |
| | |
| Ответ:
| |
| <source lang="xml">
| |
| <?xml version="1.0" encoding="UTF-8"?>
| |
| <response status="ok">
| |
| <user>
| |
| <id></id>
| |
| <isActivated>{true|false}</isActivated>
| |
| </user>
| |
| </response>
| |
| </source>
| |
| Поле '''isActivated''' - в принципе будет равно ''false'', т.к. пользователь навряд ли будет активирован на этот момент.
| |
| | |
| | |
| == user.update Обновить данные пользователя==
| |
| Запрос на обновление данных пользователя.
| |
| <source lang="xml">
| |
| <?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>
| |
| </source>
| |
| Поля, кроме '''id''', необязательные, если они не переданы в запросе - они не изменяются. Поля '''role''', '''status''' доступны для изменения только администратором.
| |
| | |
| <source lang="xml">
| |
| <?xml version="1.0" encoding="UTF-8"?>
| |
| <response status="ok">
| |
| <user>
| |
| <id></id>
| |
| </user>
| |
| </response>
| |
| </source>
| |
| | |
| | |
| == user.get Получить информацию о пользователе ==
| |
| Получить информацию о пользователе:
| |
| <source lang="xml">
| |
| <?xml version="1.0" encoding="UTF-8"?>
| |
| <request method="user.add">
| |
| <account><!-- имя аккаунта --></account>
| |
| <sid><!-- ключ сессии, полученный после аутентификации --></sid>
| |
| <user>
| |
| <id></id>
| |
| </user>
| |
| <signature></signature>
| |
| </request>
| |
| </source>
| |
| | |
| Ответ:
| |
| <source lang="xml">
| |
| <?xml version="1.0" encoding="UTF-8"?>
| |
| <response status="ok">
| |
| <user>
| |
| <id></id>
| |
| <name>Имя Отчество</name>
| |
| <lastName>Фамилия</lastName>
| |
| <login>логин используемый пользователем</login>
| |
| <email></email>
| |
| <role></role>
| |
| <status></status>
| |
| | |
| <!-- уведомления -->
| |
| <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>
| |
| <isOnline>{true|false}</isOnline><!-- пользователь в сети -->
| |
| | |
| <userGroups>
| |
| <userGroup>
| |
| <id></id>
| |
| <name></name>
| |
| </userGroup>
| |
| <userGroup>
| |
| <id></id>
| |
| <name></name>
| |
| </userGroup>
| |
| <!-- ... -->
| |
| </userGroups>
| |
| </user>
| |
| </response>
| |
| </source>
| |
| | |
| == user.getList Список пользователей ==
| |
| | |
| == Константы ==
| |
| === Роли пользователей ===
| |
| *'''ADMIN''' - Администратор
| |
| *'''USER''' - Пользователь
| |
| *'''AUDITOR''' - Аудитор
| |
| === Пол ===
| |
| *'''MALE''' - муской пол
| |
| *'''FEMALE''' - женский пол
| |
|
| |
|
| == Перейти == | | == Перейти == |
| [[ПланФикс API]] | | [[Список функций]] |
