Planfix API handbook.getRecords

From Planfix
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">
Name Type Value Note
sid string(32) session key issued as a result of authentication completion 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">
        <!-- -->
    <!--    -->
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 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">

Go To