Planfix API userGroup.getHeads: Difference between revisions
From Planfix
(Created page with "The function of obtaining a list of group supervisors. Request format: <source lang="xml"> <?xml version="1.0" encoding="UTF-8"?> <request method="userGroup.getHeads"> <account></account> <sid></sid> <userGroup> <id></id> </userGroup> <signature></signature> </request> </source> {| class="wikitable" style="margin-top: 1em; width:100% " !width="150"|Name !!width="200"| Type !!width="50%"| Value !! Note |- |userGroup.id ||int ||group identifier || |- |signatu...") |
No edit summary |
||
Line 21: | Line 21: | ||
Response: | |||
<source lang="xml"> | <source lang="xml"> | ||
<response status="ok"> | <response status="ok"> |
Latest revision as of 11:42, 11 March 2024
The function of obtaining a list of group supervisors. Request format:
<?xml version="1.0" encoding="UTF-8"?>
<request method="userGroup.getHeads">
<account></account>
<sid></sid>
<userGroup>
<id></id>
</userGroup>
<signature></signature>
</request>
Name | Type | Value | Note |
---|---|---|---|
userGroup.id | int | group identifier | |
signature | string(32) | signature |
Response:
<response status="ok">
<users count="count" totalCount="totalCount">
<user>
<!-- ... -->
</user>
<user>
<!-- ... -->
</user>
<!-- ... -->
</users>
</response>
Name | Type | Value | Note |
---|---|---|---|
users | Supervisor list | ||
users.user | user description, see the full description of the structure in the user.get section |
Otherwise, a response with an error will be returned:
<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
<code></code>
</response>