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

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

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>

Ошибки

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

Перейти

ПланФикс API