Skip to main content

 Web service API

How to use PageSeeder's Web service API

get document toc

/members/{member}/groups/{group}/uris/{uri}/documenttoc [GET]

com.pageseeder.publication.GetTOC

Description

Gets a document TOC.

Output the partial TOC for a publication including a content document (request URI marked by @content="true") and its ancestors. If URI is not in a publication, output the TOC for the URI only with no publications.

If publicationid is not specified, then the publications for this document (that the current user can access) are ordered alphabetically by display title (then by ID) and the first publication is used.

Parameters

NameDescriptionRequiredTypeDefault value
positionThe position/occurrence number of the document in the publicationnointeger1
publicationidThe publication ID for the TOCnopublicationid
versionThe publication versionnostring

Permission

Permissions requirements to be updated.
 

Response

<toc>
  ...
  [<publication ...>]
    <publication-tree uriid="55578"
                      title="Functionality"
                      content="true">
      <part level="3" uriid="55578">
        <heading-ref level="2"
                     title="Account"
                     fragment="1-2"
                     index="1"
                     numbered="true"
                     prefix="1.2.1"
                     canonical="1.2.1." />
      </part>
      <part level="3" uriid="55578">
        <heading-ref level="2"
                     title="Equations"
                     fragment="6"
                     index="1"
                     numbered="true"
                     prefix="1.2.2"
                     canonical="1.2.2." />
      </part>
    </publication-tree>
  [</publication>
  <publication .../>]
  ...
</toc>

Error Handling

No specific errors expected for this service.

Created on , last edited on