Sign in
documents

Retrieve a formatted table of contents for the document

Retrieve a formatted table of contents for the document, transformed via ODD

get/api/document/{id}/contents

Path parameters

idstring required
Example:test/kant_rvernunft_1781.TEI-P5.xml

Query parameters

collapseboolean

If true, the table of contents will be collapsed

oddstring
Example:teipublisher.odd
view'page' | 'div' | 'single'

The view type used by the main view which displays the document, e.g. 'page' or 'div'. This has an influence on the generated links, which need to differ when linking to a page rather than a section.

targetstring

The target channel into which link selection events should be send (if the user clicks on a link)

iconsboolean

Should an expand/collapse icon be displayed next to headings having nested child sections?

Headers

If-Modified-Sincestring

Response

Returns the formatted table of contents as HTML

Changes

Changed in 3 of the 49 revisions of this API.22

  • 07216792837f1See the full diff
    • ○

      added the new optional query request parameter collapse

      new-optional-request-parameter

  • d17d03cb77e81See the full diff
    • ○

      added the new optional header request parameter If-Modified-Since

      new-optional-request-parameter

  • b703599729422See the full diff
    • ●

      deleted the header request parameter If-Modified-Since

      request-parameter-removed

    • ●

      deleted the query request parameter collapse

      request-parameter-removed