Planfix API userGroup.add: Difference between revisions

Revision as of 14:05, 5 March 2024

Function for creating a group. The function is available to a user with administrator rights. Request format:

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

Name	Type	Value	Note
userGroup.name	string	name of the group being created
signature	string(32)	signature

Response upon successful group creation:

<?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 created group

Otherwise, a response with an error will be returned:

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

Go To

@@ Line 14: / Line 14: @@
 !width="150"|Name !!width="200"| Type !!width="50%"| Value !! Note
 |-
-|userGroup.name ||string || name of the group being created
+|userGroup.name ||string || name of the group being created ||
 |-
 |signature ||string(32) ||signature ||