get document toc public
/groups/{group}/uris/{uri}/documenttoc [GET]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 5.9600 | 6.0000 | xml |
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
| 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 mean standalone. | no | publicationid | |
| version | The publication version | no | string |
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