Skip to main content

 Web service API

How to use PageSeeder's Web service API

get toc

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

com.pageseeder.publication.GetTOC

Description

Output the partial TOC for a publication including a content document (request URI) and its ancestors.

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
publicationidThe publication ID for the TOCnopublicationid
loadallWhether to output the entire TOCnobooleanfalse
versionThe publication versionnostring

Permission

Requires guest or higher.

Response

<toc>
  ...
  [<publication ...>]
    <publication-tree uriid="55593"
                      title="System Report 2"
                     [last-edited="2021-04-16T16:46:31+10:00"]>
      <part level="1">
        <document-ref level="0"
                      title="Requirements"
                      documenttype="references"
                      uriid="55594"
                      position="1"
                      numbered="true"
                      prefix="1."
                      canonical="1."
                      children="true"
                     [last-edited="2021-04-14T12:40:11+10:00"]/>
        <part level="2">
          <document-ref level="0"
                        title="Functionality"
                        documenttype="default"
                        uriid="55578"
                        position="1"
                        numbered="true"
                        prefix="1.1"
                        canonical="1.1."
                        children="true"  />
          <part level="3" uriid="55578">
            <heading-ref level="2"
                         title="Account"
                         fragment="1-2"
                         index="1"
                         numbered="true"
                         prefix="1.1.1"
                         canonical="1.1.1." />
            <transclusion uriid="65579"
                          fragment="default"
                          position="1" />
          </part>
          <part level="3" uriid="55578">
            <heading-ref level="2"
                         title="Equations"
                         fragment="1-2"
                         index="2"
                         numbered="true"
                         prefix="1.1.2"
                         canonical="1.1.2." />
          </part>
        </part>      
        <part level="2">
          <document-ref level="0"
                        title="Extras"
                        documenttype="indent"
                        uriid="55595"
                        position="1"
                        numbered="true"
                        prefix="1.2"
                        canonical="1.2." />
        </part>
      </part>
      <part level="1">
        <document-ref level="0"
                      title="Bibliography"
                      documenttype="bibliography"
                      uriid="61110"
                      position="1" />
      </part>
    </publication-tree>
  [</publication>
  <publication .../>]
  ...
</toc>

Error Handling

No specific errors expected for this service.

Created on , last edited on