API.fetchBookTocs - Calaméo Knowledge Base
Not a Calaméo member yet?
Sign up now! It's FREE!
Get the latest news on Calaméo
Follow us on Facebook
Get Calaméo updates in real-time
Follow us on Twitter

API.fetchBookTocs

From Calaméo Knowledge Base

This action allows you to get the table of content of a publication.

Contents

Request

The API key must have the commons access right.
Name Required Type Description
apikey yes string API public key
signature yes string Signature of the request. See How To Sign Your Requests.
expires yes timestamp UNIX timestamp for request expiration (GMT).
output string Format of the response. Either XML (default), JSON or PHP.
book_id yes string ID of the publication.

Response

Returns an array of TOC items:

Name Type Description
Level integer Hierarchy level of the item. From 1 to the hightest.
Name string Label of the item
PageNumber integer Page number linked to the item.

Example responses

JSON

{
  response: {
    requestid: ...,
    requests: ...,
    status: ok,
    content: {
      items: [
         {
            Level: ...,
            Name: ...,
            PageNumber: ...
         }
      ]
    }
  }
}

Error codes

See the Error Codes.