fetchSubscriptionBooks

This action allows you to fetch a Folder's publications.

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

Response

This method returns an array of Publications.

Name	Type	Description
ID	string	ID of the publication
AccountID	integer	Publication's owner account ID (should be your account ID)
SubscriptionID	integer	Publication's owner subscription ID
Name	string	Title of the publication
Description	string	Description of the publication
Status	string	Conversion status of the publication. Either QUEUE (waiting to be converted), PROCESS (processing document), STORE (converting document), ERROR (error during conversion) or DONE (publication ready)
IsPublished	integer	Sends 1 if the publication is published and 0 if not
IsPrivate	integer	Sends 1 if the publication is private and 0 if not
AuthID	string	Authentication parameter for private URLs (authid)
AllowMini	integer	Sends 1 if the publication allows access to the miniCalaméo and 0 if not
Pages	integer	Number of pages of the publication
Width	integer	Width of a page of the publication
Height	integer	Height of a page of the publication
Views	integer	Number of views of the publication
Downloads	integer	Number of downloads of the publication
Comments	integer	Number of comments of the publication
Favorites	integer	Number of favorites from the publication
Date	date	Reference date of the publication
Creation	datetime	Date of creation of the publication
Publication	datetime	Scheduled date of the publication (UTC)
Modification	datetime	Date of the last modification of the publication
PosterUrl	string	Absolute URL for the publication's larger cover
PictureUrl	string	Absolute URL for the publication's cover
ThumbUrl	string	Absolute URL for the publication's thumbnail
PublicUrl	string	Absolute URL for the publication's overview
ViewUrl	string	Absolute URL for the publication's reading page

Example response

JSON

{
  "response": {
    "status": "ok",
    "version": 2,
    "requestid": "ll7eoz",
    "requests": 209,
    "content": {
      "total": 1,
      "start": 0,
      "step": 10,
      "items": [
        {
          "ID": "0045168254f0132f6cf5f",
          "SubscriptionID": 4540112,
          "AccountID": 4516825,
          "Name": "Guided Tour EN",
          "Description": "www.calameo.com CALAMÉO GUIDED TOUR ENGLISH",
          "Category": "MISC",
          "Format": "MISC",
          "Dialect": "en",
          "Status": "DONE",
          "IsPublished": 1,
          "IsPrivate": 1,
          "AuthID": "dXT0xqsM5qjx",
          "AllowMini": 1,
          "Date": "2015-10-16",
          "Pages": 12,
          "Width": 595,
          "Height": 841,
          "Views": 0,
          "Downloads": 0,
          "Comments": 0,
          "Favorites": 0,
          "PosterUrl": "https://i.calameoassets.com/151016113106-69d5960ce53f69b75910e802001e6adf/large.jpg",
          "PictureUrl": "https://i.calameoassets.com/151016113106-69d5960ce53f69b75910e802001e6adf/thumb.jpg",
          "ThumbUrl": "https://i.calameoassets.com/151016113106-69d5960ce53f69b75910e802001e6adf/p1.jpg",
          "PublicUrl": "https://www.calameo.com/books/0045168254f0132f6cf5f?authid=dXT0xqsM5qjx",
          "ViewUrl": "https://www.calameo.com/read/0045168254f0132f6cf5f?authid=dXT0xqsM5qjx",
          "Creation": "2015-10-16 11:31:06",
          "Modification": "2015-10-16 11:31:51"
        }
      ]
    }
  }
}