API.fetchBookComments - 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.fetchBookComments

From Calaméo Knowledge Base

This action allows you to get the comments of a publication.

<toc>

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.
order string String of characters used to define the organization criteria of the comments. Only Date is available for now.
way string String of characters used to define the sort order. Either UP (default) or DOWN.
start integer Start position of the range of comments. Default is 0.
step integer Number of comments to be sent from the start position (max: 50).

Response

Returns an array of comments:

Name Type Description
PosterID integer ID of the comment poster.
PosterName string Name of the comment poster.
PosterPublicUrl string Absolute URL for the comment poster's page.
PosterThumbUrl string Absolute URL for the comment poster's thumbnail.
Date date Date of the comment.
Text string Text of the comment.

Example responses

JSON

{
  response: {
    requestid: ...,
    requests: ...,
    status: ok,
    content: {
      total: ...,
      start: ...,
      step: ...,
      items: [
         {
            PosterID: ...,
            PosterName: ...,
            PosterPublicUrl: ...,
            PosterThumbUrl: ...,
            Date: ...,
            Text: ...
         }
      ]
    }
  }
}

Error codes

See the Error Codes.