getSubscriptionInfos

This action allows you to recover information about a Folder.

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

Response

This method returns a Folder.

Name	Type	Description
ID	integer	Unique identifying key for the folder
AccountID	integer	Unique identifying key for the account of the folder
Name	string	Title of the folder
Description	string	Description of the folder
Books	integer	Available publications inside the folder
Subscribers	integer	Available subscribers inside the folder (only returned for your account's folder)
Creation	datetime	Date of the folder's creation
Modification	datetime	Date of the folder's last modification
PublicUrl	string	Absolute URL for the folder's overview

Example response

JSON

{
  "response": {
    "status": "ok",
    "version": 2,
    "requestid": "eK4YhB",
    "requests": 161,
    "content": {
      "ID": 4540112,
      "AccountID": 4516825,
      "Name": "Mon dossier",
      "Description": "",
      "Books": 0,
      "Subscribers": 0,
      "Creation": "2015-10-06 16:55:39",
      "Modification": "2015-10-06 16:55:39",
      "PublicUrl": "https://www.calameo.com/subscriptions/4540112"
    }
  }
}