Planfix API userGroup.update: Difference between revisions

From Planfix
Jump to: navigation, search
(Created page with "This function updates group information. It is only available for users with administrator rights. Request format: <source lang="xml"> <?xml version="1.0" encoding="UTF-8"?> <request method="userGroup.update"> <account></account> <sid></sid> <userGroup> <id></id> <name></name> </userGroup> <signature></signature> </request> </source> {| class="wikitable" style="margin-top: 1em; width:100% " !width="150"|Name !!width="200"| Type !!width="50%"| Value !! N...")
 
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
This function updates group information. It is only available for users with administrator rights. Request format:
Function for updating group information. It is only available for users with administrator rights. Request format:
<source lang="xml">
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<?xml version="1.0" encoding="UTF-8"?>
Line 51: Line 51:
== Go To ==
== Go To ==
*[[Planfix API:Managing user groups]]
*[[Planfix API:Managing user groups]]
*[[Error codes]]
*[[Error codes XML API v1|Error codes]]
*[[List of functions]]
*[[List of functions]]

Latest revision as of 09:31, 6 March 2024

Function for updating group information. It is only available for users with administrator rights. Request format:

<?xml version="1.0" encoding="UTF-8"?>
<request method="userGroup.update">
  <account></account>
  <sid></sid>
  <userGroup>
    <id></id>
    <name></name>
  </userGroup>
  <signature></signature>
</request>
Name Type Value Note
id int identifier of the group being updated
name string new group name
signature string(32) signature

Response when the function is successfully executed:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <userGroup>
    <id></id>
  </userGroup>
</response>
Name Type Value Note
userGroup.id int identifier of the group being updated


Otherwise, a response with an error will be returned:

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


Go To