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

From Calaméo Knowledge Base

This action allows you to recover all the periodic subscriptions of a subscriber

<toc>

Request

Note: This feature is only available to PREMIUM and PLATINUM users. Click Here To Upgrade.
The API key must have the subscribers_read 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.
subscription_id yes integer ID of the subscription.
login yes string Login of the subscriber.

Response

Name Type Description
ID integer DRM ID.
SubscriptionID integer ID of the subscription.
SubscriberLogin string Login of the subscriber.
From date Start date of the subscription period.
To date End date of the subscription period.
Date datetime Date of the subscription.
Extras string Free field of up to 255 characters

This request sends a array containing the requested subscriptions with the following information:

Example responses

JSON

{
  response: {
    requestid: ...,
    requests: ...,
    status: ok,
    content: {
      total: ...,
      start: ...,
      step: ...,
      items: [
         {
            ID: ...,
            SubscriptionID: ...,
            SubscriberLogin: ...,
            From: ...,
            To: ...,
            Date: ...,
            Extras: ...
         }
      ]
    }
  }
}

Error codes

See the Error Code Section.