Planfix API handbook.getList: Difference between revisions

From Planfix
Jump to: navigation, search
(Created page with "The request to get a list of directories looks like this: <source lang="xml"> <?xml version="1.0" encoding="UTF-8"?> <request method="handbook.getList"> <account></account> <sid></sid> <group> <id></id> </group> <signature></signature> </request> </source> {| class="wikitable" style="margin-top: 1em; width:100% " !width="150"|Name !!width="200"| Type !!width="50%"| Value !! Note |- |account|| string ||account on which the request is executed ||...")
 
No edit summary
Line 16: Line 16:
|account|| string ||account on which the request is executed ||
|account|| string ||account on which the request is executed ||
|-
|-
|sid || string(32) ||session key || issued as a result of [[Planfix API: Authentication|authentication]]]  
|sid || string(32) ||session key || issued as a result of [[Planfix API: Authentication|authentication]]  
|-
|-
|group.id || int || group identifier || optional parameter
|group.id || int || group identifier || optional parameter

Revision as of 14:52, 20 March 2024

The request to get a list of directories looks like this:

<?xml version="1.0" encoding="UTF-8"?>
<request method="handbook.getList">
    <account></account>
    <sid></sid>
    <group>
      <id></id>
    </group>
    <signature></signature>
</request>
Name Type Value Note
account string account on which the request is executed
sid string(32) session key issued as a result of authentication
group.id int group identifier optional parameter
signature string(32) package signature

Response, when the request is successfully executed:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
    <handbooks count="count" totalCount="totalCount">
        <handbook>
            <id></id>
            <name></name>
            <group>
                <id></id>
                <name></name>
            </group>
        </handbook>
        <handbook>
            <id></id>
            <name></name>
            <group>
                <id></id>
                <name></name>
            </group>
        </handbook>
        <!-- ... -->
    </handbooks>
</response>
Name Type Value Note
handbooks int list of directories
handbooks count int number of directories in the list
handbooks totalCount int total number of directories in the list
handbook directory
handbook.id int directory identifier
handbook.name string directory name
handbook.group group
handbook.group.id int group identifier
handbook.group.name string group name

Otherwise, an error response will be returned:

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


Go To