fetchBookComments

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

info

The API key must have access rights to commons.

Request

Name		Type	Description
apikey	Required	string	API public key
signature	Required	string	Signature of the request.
expires		timestamp	UNIX timestamp for request expiration (GMT)
output		string	Format of the response. Either XML (default), JSON or PHP
book_id	Required	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

This method 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 response

JSON

{
  "response": {
    "status": "ok",
    "version": 2,
    "requestid": "K2o07v",
    "requests": 207,
    "content": {
      "total": 0,
      "start": 0,
      "step": 10,
      "items": []
    }
  }
}