Planfix API handbook.getRecords

From Planfix
Revision as of 13:05, 13 March 2024 by Dmitri (talk | contribs) (Created page with "Obtaining directory entries. If groups are present, it returns entries of one level. Request format: <source lang="xml"> <?xml version="1.0" encoding="UTF-8"?> <request method="handbook.getRecords"> <account></account> <sid></sid> <handbook> <id></id> </handbook> <parentKey></parentKey> <pageCurrent></pageCurrent> <pageSize></pageSize> <signature></signature> </request> </source> {| class="wikitable" style="margin-top: 1em; width:100% " !width="150"|...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Obtaining directory entries. If groups are present, it returns entries of one level. Request format:

<?xml version="1.0" encoding="UTF-8"?>
<request method="handbook.getRecords">
  <account></account>
  <sid></sid>
  <handbook>
    <id></id>
  </handbook>
  <parentKey></parentKey>
  <pageCurrent></pageCurrent>
  <pageSize></pageSize>
  <signature></signature>
</request>
Name Type Value Note
sid string(32) session key issued as a result of authentication completion
handbook.id int directory identifier
parentKey int entry group identifier optional parameter
pageCurrent int page number from 1
pageSize int page size up to 100

Response when the request is successfully executed:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <records>
    <record>
      <parentKey></parentKey>
      <isGroup></isGroup>
      <key></key>
      <name></name>
      <archived></archived>
      <customData>
        <customValue>
          <field>
            <id></id>
          </field>
          <value></value>
          <text></text>
        </customValue>
        <!-- -->
      </customData>
    </record>
    <!--    -->
  </records>
</response>
Name Type Value Note
parentKey int entry group identifier
isGroup bool is the entry a group
key int entry identifier
name string name, if the entry is a group
archived bool is the entry archived
customData entry data
customData.customValue.field.id field identifier
customData.customValue.value field value
customData.customValue.text text value of the field

Otherwise, a response with an error will be returned:

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


Go To