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

Материал из ПланФикс
Перейти к: навигация, поиск
(→‎userGroup.get Получить)
(→‎userGroup.getList Получить список групп)
Строка 72: Строка 72:
 
</response>
 
</response>
 
</source>
 
</source>
 +
  
 
== userGroup.getList Получить список групп ==
 
== userGroup.getList Получить список групп ==
 +
Получение полного списка групп пользователей на аккаунте. Не требует админ прав.
 +
<source lang="xml">
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<request method="userGroup.update">
 +
  <account><!-- имя аккаунта --></account>
 +
  <sid><!-- ключ сессии, полученный после аутентификации --></sid>
 +
  <signature></signature>
 +
</request>
 +
</source>
  
 +
Отвте:
 +
<source lang="xml">
 +
<?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>
 +
</source>
 +
Для пользователей не с админ правами, значение поля '''userCount''' - будет всегда рано '''0'''.
  
 
== Ошибки ==
 
== Ошибки ==

Версия 07:50, 11 августа 2010

Создание, правка и удаление групп. Функции 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>


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

Источник — «http://planfix.ru/wiki/index.php?title=ПланФикс_API:Управление_группами_пользователей&oldid=165»