Planfix API handbook.getGroupList

Request to get a list of directory groups looks like this:

<?xml version="1.0" encoding="UTF-8"?>
<request method="handbook.getGroupList">
    <account></account>
    <sid></sid>
    <signature></signature>
</request>

Name	Type	Value	Note
account	string	the account on which the request is executed
sid	string(32)	session key	issued as a result of passing authentication
signature	string(32)	package signature

The response, if the request is successfully executed:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
    <handbookGroups count="count" totalCount="totalCount">
        <group>
            <id></id>
            <name></name>
        </group>
        <group>
            <id></id>
            <name></name>
        </group>
        <!-- ... -->
    </handbookGroups>
</response>

Name	Type	Value	Note
handbookGroups	int	groups list
handbookGroups count	int	number of groups in the list
handbookGroups totalCount	int	total number of groups in the list
group		group
group.id	int	group identifier
group.name	string	group name

Otherwise, a response with an error will be returned:

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

Go To

• Planfix API:Directories
• Error codes
• List of functions