Skip to main content

addSubscriberDRMPeriod

This action allows you to create an access to publications within a period of time.

info

The API key must have access rights to subscribers_write.

Request​

NameTypeDescription
apikeyRequiredstringAPI public key
signatureRequiredstringSignature of the request.
expirestimestampUNIX timestamp for request expiration (GMT)
outputstringFormat of the response. Either XML (default), JSON or PHP
subscription_idRequiredintegerID of the folder
loginRequiredstringLogin of the subscriber
fromRequireddateStart date of the period (YYYY-MM-DD)
toRequireddateEnd date of the period (YYYY-MM-DD)
extrasstringFree field up to 255 characters

Response​

This method returns a period DRM.

NameTypeDescription
IDintegerID of the DRM
SubscriptionIDintegerID of the folder
SubscriberLoginstringLogin of the subscriber
FromdateStart date of the period (YYYY-MM-DD)
TodateEnd date of the period (YYYY-MM-DD)
ExtrasstringFree field up to 255 characters

Example response​

JSON
{
"response": {
"status": "ok",
"version": 2,
"requestid": "Oui7af",
"requests": 168,
"content": {
"ID": 77859,
"SubscriptionID": 4540112,
"SubscriberLogin": "leia",
"From": "2015-09-01",
"To": "2016-09-01",
"Date": "2015-10-16 11:31:05",
"Extras": ""
}
}
}