Planfix API userGroup.update: Difference between revisions
From Planfix
No edit summary |
(→Go To) |
||
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>