|  |  | 
| Строка 5: | Строка 5: | 
|  | #[[ПланФикс API userGroup.get|userGroup.get / Получить]] |  | #[[ПланФикс API userGroup.get|userGroup.get / Получить]] | 
|  | #[[ПланФикс API userGroup.getList|userGroup.getList / Получить список групп]] |  | #[[ПланФикс API userGroup.getList|userGroup.getList / Получить список групп]] | 
|  | 
 |  | 
|  | == userGroup.add Создать группу ==
 |  | 
|  | Запрос на создание:
 |  | 
|  | <syntaxhighlight lang="xml">
 |  | 
|  | <?xml version="1.0" encoding="UTF-8"?>
 |  | 
|  | <request method="userGroup.add">
 |  | 
|  |   <account><!-- имя аккаунта --></account>
 |  | 
|  |   <sid><!-- ключ сессии, полученный после аутентификации --></sid>
 |  | 
|  |   <userGroup>
 |  | 
|  |     <name></name>
 |  | 
|  |   </userGroup>
 |  | 
|  | </request>
 |  | 
|  | </syntaxhighlight>
 |  | 
|  | 
 |  | 
|  | Ответ при удачном создании группы:
 |  | 
|  | <source lang="xml">
 |  | 
|  | <?xml version="1.0" encoding="UTF-8"?>
 |  | 
|  | <response status="ok">
 |  | 
|  |   <userGroup>
 |  | 
|  |     <id></id>
 |  | 
|  |   </userGroup>
 |  | 
|  | </response>
 |  | 
|  | </source>
 |  | 
|  | 
 |  | 
|  | 
 |  | 
|  | == userGroup.update Обновить ==
 |  | 
|  | Изменение группы - только название.
 |  | 
|  | <source lang="xml">
 |  | 
|  | <?xml version="1.0" encoding="UTF-8"?>
 |  | 
|  | <request method="userGroup.update">
 |  | 
|  |   <account><!-- имя аккаунта --></account>
 |  | 
|  |   <sid><!-- ключ сессии, полученный после аутентификации --></sid>
 |  | 
|  |   <userGroup>
 |  | 
|  |     <id></id>
 |  | 
|  |     <name></name>
 |  | 
|  |   </userGroup>
 |  | 
|  | </request>
 |  | 
|  | </source>
 |  | 
|  | Ответ:
 |  | 
|  | <source lang="xml">
 |  | 
|  | <?xml version="1.0" encoding="UTF-8"?>
 |  | 
|  | <response status="ok">
 |  | 
|  |   <userGroup>
 |  | 
|  |     <id></id>
 |  | 
|  |   </userGroup>
 |  | 
|  | </response>
 |  | 
|  | </source>
 |  | 
|  | 
 |  | 
|  | 
 |  | 
|  | == userGroup.get Получить ==
 |  | 
|  | Следующая функция не требует админ прав у пользователя.
 |  | 
|  | <source lang="xml">
 |  | 
|  | <?xml version="1.0" encoding="UTF-8"?>
 |  | 
|  | <request method="userGroup.get">
 |  | 
|  |   <account><!-- имя аккаунта --></account>
 |  | 
|  |   <sid><!-- ключ сессии, полученный после аутентификации --></sid>
 |  | 
|  |   <id></id>
 |  | 
|  |   <signature></signature>
 |  | 
|  | </request>
 |  | 
|  | </source>
 |  | 
|  | 
 |  | 
|  | Ответ:
 |  | 
|  | <source lang="xml">
 |  | 
|  | <?xml version="1.0" encoding="UTF-8"?>
 |  | 
|  | <response status="ok">
 |  | 
|  |   <userGroup>
 |  | 
|  |     <id></id>
 |  | 
|  |     <name></name>
 |  | 
|  |     <userCount>количество пользователей в группе</userCount>
 |  | 
|  |   </userGroup>
 |  | 
|  | </response>
 |  | 
|  | </source>
 |  | 
|  | 
 |  | 
|  | 
 |  | 
|  | == 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'''.
 |  | 
|  | 
 |  | 
|  | == Ошибки ==
 |  | 
|  | *5001 - нет прав на выполнение данной операции
 |  | 
|  | 
 |  | 
|  | 
 |  | 
 | 
|  | == Перейти == |  | == Перейти == | 
|  | [[ПланФикс API]] |  | [[ПланФикс API]] |