Planfix API userGroup.add

From Planfix
Revision as of 09:30, 6 March 2024 by Dmitri (talk | contribs) (→‎Go To)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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