LogoLogo
  • iPaper Technical Documentation
  • Display Analytics
    • Google Analytics
  • Display JavaScript API
    • Quick Start
    • Commands
    • Events
  • Flipbook Analytics
    • Adobe Analytics events
    • Google Analytics / GTM events
  • Flipbook Backend API
    • Overview
    • Return Codes
    • Ecommerce
      • GetFlipbookOrdersByType
      • GetLicenseOrdersByType
    • Image
      • GetImageWith2PxDropShadow
    • Link
      • GetLinks
    • Media
      • CreateDirectory
      • DeleteDirectory
      • DeleteFile
      • GetTree
      • UploadFile
    • Paper
      • ChangePaperUrl
      • ClearPublicationPeriod
      • CreateCategory
      • CreatePaper
      • CreatePreviewToken
      • DeletePaper
      • GetAllPapers
      • GetPaperIDFromUrl
      • GetPaperStructure
      • GetPaperUrlFromID
      • GetSetting
      • GetSettingDescriptions
      • MovePaper
      • SetPublicationPeriod
      • SetSetting
    • Ripper
      • GetProcessingPapers
      • GetProcessingStatus
      • ProcessPDF
      • ReprocessPaper
    • Search
      • SearchPapersByContent
      • SearchPapersByCustomFields
      • SearchPapersWithHiearchyByContent
      • SearchPapersWithHiearchyByName
    • Statistics
      • GetNumberOfPageviewsPerDay
      • GetNumberOfVisitors
      • GetNumberOfVisitorsPerDay
  • Flipbook Enrichment
    • Popup Content
    • Popup Frame
  • Flipbook Integration
    • Custom Domain
    • Custom Mail
    • Embedding flipbooks inside iOS and Android App
    • Form Integration
    • Iframing Flipbooks
    • iPaper Embed Script (Pop-ups)
    • Embeds (Minipapers)
    • Query String Parameters
    • Remote Authentication
    • Shop Export
  • Flipbook JavaScript API
    • Getting Started
    • Commands & Events
      • Basket
      • Consent
        • Example Implementations
          • UserCentrics
          • OneTrust
          • CookieInformation
          • Cookiebot
      • Paging
      • Publication
      • Search
      • Table of Contents
      • Sharing
    • Advanced Usage
    • Migration guide
    • Legacy Javascript API (v2)
      • Quick Start
      • Commands
      • Events
      • Consent Management
      • Advanced Usage
  • Technical Information
    • Cookie Information
    • Common security questions
    • Open Source
Powered by GitBook
On this page
  • Description
  • Parameters
  • Sample Response
  • Return Codes
  1. Flipbook Backend API
  2. Paper

GetAllPapers

Description

Returns an XML document listing all categories and iPapers below, and including, the requested PaperID. If a publication period restriction is set on the iPaper, the publicationperiod-from and publicationperiod-to fields will be present. Publication periods returned in the response are UTC time zone.

Parameters

Name
Value

paperID

The ID of the iPaper that should be the root level of the tree of iPapers returned

Sample Response

<?xml version="1.0" encoding="utf-8"?>
<result>
  <code><![CDATA[SUCCESS]]></code>
  <message><![CDATA[List of papers retrieved.]]></message>
  <data>
    <category id="182" name="Partner" url="/">
      <category id="173" name="Demos" url="/demos/">
        <category id="1240" name="hep23" url="/demos/hep23/" />
        <paper id="1106" name="21" url="/demos/21/" />
        <paper id="1114" name="CC" url="/demos/CC/" />
        <paper id="1120" name="Dot_Matrix_Range" url="/demos/Dot_Matrix_range/" publicationperiod-from="2014-05-14 01:25:00" publicationperiod-to="2014-05-29 01:35:00" />
        <paper id="1117" name="edc" url="/demos/edc/" />
        <paper id="1233" name="ipaper" url="/demos/ipaper/" />
        <paper id="1232" name="Test" url="/demos/Test/" />
      </category>
    </category>
  </data>
</result>

Return Codes

  • SUCCESS

  • ERROR

PreviousDeletePaperNextGetPaperIDFromUrl

Last updated 2 years ago