toc
Returns the TOC for a pub (or a single topic), in XML form.
Description
Returns the TOC (i.e. ditamap) for a publication language version (or a single topic), in XML form.
Parameters
- action
- toc
- docid
- The document id of requested resource.
- title
-
Optional parameter used when a
docidparameter is provided. If set to 1, then the <ancestor> elements for the targeted topic also include a @navtitle and @shortdesc attributes, including this metadata about the ancestor elements in the TOC. Defaults to 0. - area
- The area of the requested resource e.g. 'live', 'holding'.
- format
- The output format for the results. Either "html" or "xml". Defaults to "xml"
- lang
- A language version of a publication.
- pub
- A publication, which is a logical grouping of information (topics and multimedia) related to a specific subject, containing one or more language versions.
Example URL
http://<host>:<port>/<context>/web/content.xql?action=toc&docid=<value>&title=<value>&area=<value>&format=<value>&lang=<value>&pub=<value>
Successful Result
In the default case, the TOC (toc.xml) is returned in XML form; if a docid is provided, only the <ancestor> elements for that topic from the TOC are returned.
Failed Result
404 error if language version is not visible.
Permission exception if user does not have 'Use application' permission.