Get a Map ToC - Fluid Topics - 3.6 - Technical Notes

Use Fluid Topics Web APIs

Product
Fluid Topics
FT_Version
3.6
Category
Technical Notes
language
English
audience
public

This web service returns the table of contents (ToC) of a map in a tree-like way.

Method

Endpoint

GET

/api/khub/maps/$MAP_ID/toc

Where:

  • $MAP_ID is the map identifier.

Output Example

[
{
"tocId": "KxbC9L7TkevNADo3Zbtaeg",
"contentId": "GCJIxaakrouF867B8SCY2w",
"title": "Chapter 1",
"children": [
{
"tocId": "2ehJkhbIBAhnpcFlFkC_KA",
"contentId": "u_KqDPMiBVLzqDycTFTM3w",
"title": "Chapter 1.1",
"children": [ ]
},
{
"tocId": "Ft8hnNVFV6oK7vhjqYvlVQ",
"contentId": "UpCQdQKOTOlUuY8VJvAsig",
"title": "Chapter 1.2",
"children": [ ]
},
{
"tocId": "QI8qZWAbK4wCLM3oaN5KCA",
"contentId": "wZobJuWtpMfiRF2JHwoO_g",
"title": "Reused Topic",
"children": [ ]
}
]
},
{
"tocId": "iJJsOykhJq_sSuo7fJkSrw",
"contentId": "AdJ10x_6RN53blZFBYnYSA",
"title": "Chapter 2",
"children": [
{
"tocId": "eg2D_KmawqwMPrdWUU4XbA",
"contentId": "lnDkrCyyPd1pY2gRH7vA7A",
"title": "Chapter 2.1",
"children": [ ]
},
{
"tocId": "HM5Xn4XLhlit5HvBtYAGwQ",
"contentId": "xZNQrIX4T2Uogwxi07OsEw",
"title": "Chapter 2.2",
"children": [ ]
},
{
"tocId": "3GPbHMwUQMN42l74t3CnIQ",
"contentId": "wZobJuWtpMfiRF2JHwoO_g",
"title": "Reused Topic",
"children": [ ]
}
]
},
...
]

Where:

  • "contentId" is the identifier of a topic in a book. This topic can be reused multiple times inside the book.
  • "tocId" (or "Table of Contents ID") is the identifier of a ToC entry. This is a given topic, in a given book, at a given place in that book.