get document toc
/members/{member}/groups/{group}/uris/{uri}/documenttoc [GET]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 5.9600 | 6.0000 | xml |
Description
Returns the Table of Contents (TOC) for the document.
Output the partial TOC for a publication including this document only (no 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
| Name | Description | Required | Type | Default |
|---|---|---|---|---|
| position | The position/occurrence number of the document in the publication | no | integer | 1 |
| publicationid | The publication ID for the TOC, empty means standalone. | no | publicationid | |
| version | The publication version | no | string |
Permission
Requires guest or higher.
Response
<toc>
...
[<publication ...>]
<publication-tree uriid="55578"
title="Functionality"
content="true"
[last-edited="2021-04-16T16:46:31+10:00"]>
<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."
[last-edited="2021-04-14T12:40:11+10:00"]/>
</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.