ПланФикс API userGroup.getList — различия между версиями

Версия 11:59, 27 октября 2010

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

<?xml version="1.0" encoding="UTF-8"?>
<request method="userGroup.update">
  <account></account>
  <sid></sid>
  <signature></signature>
</request>

Название	Тип	Значение
account	string	имя аккаунта, на котором выполняется функция
sid	string(32)	ключ сессии
signature	string(32)	подпись

Отвте:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <userGroups count="count" totalCount="totalCount">
    <userGroup>
      <id></id>
      <name></name>
      <userCount></userCount>
    </userGroup>
    <userGroup>
      <id></id>
      <name></name>
      <userCount></userCount>
    </userGroup>
    <!-- ... -->
  </userGroups>
</response>

Название	Тип	Значение
userGroups		корневой элемент, содержащий список групп
userGroups count	int	количество групп возвращенных запросом
userGroups totalCount	int	количество групп удовлетворяющих запросу
userGroup		элемент группы
userGroup.id	int	идентификатор группы
userGroup.name	string	название группы
userGroup.userCount	int	количество пользоавателей в группе

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

В противном случае будет возвращен ответ с ошибкой:

<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
  <code></code>
</response>

Значение code	Расшифровка
0000	неизвестная ошибка

Перейти

@@ Строка 75: / Строка 75: @@
 == Перейти ==
-*[[ПланФикс API]]
 *[[ПланФикс API:Управление группами пользователей]]
+*[[Список функций]]