Web service API

How to use PageSeeder's Web service API

get document toc public

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

com.pageseeder.publication.GetTOC

Description

Gets a document TOC (public)

Output the partial TOC for a publication including a content document (request URI) and it's ancestors. If URI is not in a publication output the TOC for the URI only with no publications.

Parameters

NameDescriptionRequiredTypeDefault value
positionThe position/occurrence number of the document in the publication.nointeger1
publicationidThe publication ID for the TOC.nopublicationid

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 generator.

Created on , last edited on