GetPaperStructure

Description

Returns an XML document listing all pages and page images for the requested PaperID.

Note:

You should not reference these urls from your own systems as they may change at any point. If you want to use the images, you should download them locally and host them yourself. We also may redirect the user to other domains, so they mustn’t be references from Flash files directly, as crossdomain needs may change dynamically.

Parameters

Name
Value

paperID

The ID of the iPaper whose structure should be returned

includeIndexedText

If true, returns the text iPaper has indexed from each page

Sample Response (Without Text)

<?xml version="1.0" encoding="utf-8"?>
<result>
  <code><![CDATA[SUCCESS]]></code>
  <message><![CDATA[Paper structure retrieved.]]></message>
  <data>
    <paper id="1120" name="Dot_Matrix_Range" url="/demos/Dot_Matrix_range/">
      <pages>
        <page id="58367" number="1" part-of-index="False">
          <images>
            <image file-size="300" type="Zoom" url="http://flex.frontend.dk/demos/Dot_Matrix_range/Image.ashx?PageID=58367&amp;ImageType=Zoom" />
            <image file-size="90" type="Normal" url="http://flex.frontend.dk/demos/Dot_Matrix_range/Image.ashx?PageID=58367&amp;ImageType=Normal" />
            <image file-size="6" type="Thumb" url="http://flex.frontend.dk/demos/Dot_Matrix_range/Image.ashx?PageID=58367&amp;ImageType=Thumb" />
          </images>
        </page>
        ...
      </pages>
    </paper>
  </data>
</result>

Sample Response (With Text)

Return Codes

  • SUCCESS

  • ERROR

PreviousGetPaperIDFromUrlNextGetPaperUrlFromID

Last updated