ПланФикс API: Управление группами пользователей

Создание, правка и удаление групп. Функции userGroup.add и userGroup.update доступны учетной записи с правами Администратор.

1. userGroup.add / Создать группу
2. userGroup.update / Обновить
3. userGroup.get / Получить
4. userGroup.getList / Получить список групп

userGroup.add Создать группу

Запрос на создание:

<?xml version="1.0" encoding="UTF-8"?>
<request method="userGroup.add">
  <account><!-- имя аккаунта --></account>
  <sid><!-- ключ сессии, полученный после аутентификации --></sid>
  <userGroup>
    <name></name>
  </userGroup>
</request>

Ответ при удачном создании группы:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <userGroup>
    <id></id>
  </userGroup>
</response>

userGroup.update Обновить

Изменение группы - только название.

<?xml version="1.0" encoding="UTF-8"?>
<request method="userGroup.update">
  <account><!-- имя аккаунта --></account>
  <sid><!-- ключ сессии, полученный после аутентификации --></sid>
  <userGroup>
    <id></id>
    <name></name>
  </userGroup>
</request>

Ответ:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <userGroup>
    <id></id>
  </userGroup>
</response>

userGroup.get Получить

Следующая функция не требует админ прав у пользователя.

<?xml version="1.0" encoding="UTF-8"?>
<request method="userGroup.get">
  <account><!-- имя аккаунта --></account>
  <sid><!-- ключ сессии, полученный после аутентификации --></sid>
  <id></id>
  <signature></signature>
</request>

Ответ:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <userGroup>
    <id></id>
    <name></name>
    <userCount>количество пользователей в группе</userCount>
  </userGroup>
</response>

userGroup.getList Получить список групп

Получение полного списка групп пользователей на аккаунте. Не требует админ прав.

<?xml version="1.0" encoding="UTF-8"?>
<request method="userGroup.update">
  <account><!-- имя аккаунта --></account>
  <sid><!-- ключ сессии, полученный после аутентификации --></sid>
  <signature></signature>
</request>

Отвте:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <userGroups count="x" totalCount="x">
    <userGroup>
      <id></id>
      <name></name>
      <userCount>количество пользователей в группе</userCount>
    </userGroup>
    <userGroup>
      <id></id>
      <name></name>
      <userCount>количество пользователей в группе</userCount>
    </userGroup>
    <!-- ... -->
  </userGroups>
</response>

Для пользователей не с админ правами, значение поля userCount - будет всегда рано 0.

Ошибки

• 5001 - нет прав на выполнение данной операции

Перейти

ПланФикс API