Skip to main content

documents/{document_id}/pages

Retrieves all the pages defined within a specified document within the Platform. If a document had the insufficient_privileges attribute set as true then you will not be able to retrieve the pages for the document. Similarly if the requires_password attribute is set as true then you will need to provide the correct password argument.

Arguments:

  • api_key (required)
  • per_page (optional - default 25)
  • page (optional - default 1)
  • document_id (required)
  • password (required depending on document access restrictions)

Example request:

http://[domain]/api/documents/2/pages.xml?api_key=[api_key]&per_page=10&page=1

Example response:

<?xml version="1.0" encoding="utf-8"?>
<pages document_id="2344" page="1" pages="1" per_page="10" total="3">
    <page id="8544" page_number="1">
        <title>Longsight Ward Co-ordination</title>
        <image>http://mysite.co.uk/images/image.jpg</image>
        <date>1235998197</date>
        <content><![CDATA[First page of content here.]]></content>
    </page>
    <page id="14183" page_number="2">
        <title>Longsight Ward Map</title>
        <image></image>
        <date>1227170511</date>
        <content><![CDATA[Second page of content here.]]></content>
    </page>
</pages>