Skip to main content

 Services

Web services from /about to /webhooks

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 its ancestors. If URI is not in a publication, output the TOC for the URI only with no publications.

Parameters

NameDescriptionRequiredTypeDefault
positionThe position/occurrence number of the document in the publicationnointeger1
publicationidThe publication ID for the TOC, empty mean standalone.nopublicationid
versionThe publication versionnostring

Permission

This service is restricted to guest and higher unless the group is accessible to public.

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