EEeeditiones
documents

Retrieve a formatted table of contents for the document

Changed on

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

get/api/document/{id}/contents

Request

  • Base URL
    /exist/apps/tei-publisher (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    • API key in cookie teipublisher.com.login
    • or HTTP basic

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