Difference between revisions of "GetUserSubscriptions"
Jump to navigation
Jump to search
| (12 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
Description=Returns the list of [[Subscription]] objects that belong to the user. This method can only be accessed with a valid logged token (not accessible by anonymous). | Description=Returns the list of [[Subscription]] objects that belong to the user. This method can only be accessed with a valid logged token (not accessible by anonymous). | ||
| − | It automatically filters the results to return only subscription types Normal (1) and AllPlaylist ( | + | This method retrieves all the subscriptions applying some filters: |
| − | + | * It automatically filters the results to return only subscription types Normal (1) and AllPlaylist (4) (see [[SubscriptionType]] enumeration). | |
| − | It also filters out Subscriptions with [[SubscriptionPurchaseType]] = Provisioning Only, returning only Bottom Up and Both. | + | * It also filters out Subscriptions with [[SubscriptionPurchaseType]] = Provisioning Only, returning only Bottom Up and Both. (Except if applyProvisioningFilter is set to true) |
| Line 27: | Line 27: | ||
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| − | ParamName= | + | ParamName= applyProvisioningFilter |
| − | |ParamType= | + | |ParamType=bool |
|ParamRequired=optional | |ParamRequired=optional | ||
| − | |ParamDescription= | + | |ParamDescription=<span style='color: green'>((NEW IN 2.4)</span> |
| + | false (default value): the method will return Subscriptions with Purchase Type in (Both, ApiOnly). | ||
| + | true: the method will return Subscriptions with Purchase Type in (Both, ApiOnly, ProvisioningOnly). | ||
}} | }} | ||
| + | |||
| + | |||
|Returns= | |Returns= | ||
Returns a JSON object containing an array of [[Subscription]]. | Returns a JSON object containing an array of [[Subscription]]. | ||
| Line 61: | Line 65: | ||
! Changes author | ! Changes author | ||
{{!}}- valign="top" | {{!}}- valign="top" | ||
| + | |||
! 1.0 | ! 1.0 | ||
{{!}} Initial method design | {{!}} Initial method design | ||
{{!}} Harley Cabral | {{!}} Harley Cabral | ||
| + | {{!}}- valign="top" | ||
| + | |||
| + | ! 2.4 | ||
| + | {{!}} New parameter '''applyProvisioningFilter''' | ||
| + | {{!}} Ricardo Calvo | ||
| + | {{!}}- valign="top" | ||
{{!}}} | {{!}}} | ||
|SeeAlso= | |SeeAlso= | ||
| − | * [[ | + | * [[SubscriptionType]] enumeration |
* [[SubscriptionPurchaseType]] enumeration | * [[SubscriptionPurchaseType]] enumeration | ||
* [[Subscription]] object | * [[Subscription]] object | ||
* [[UNIAPI_Specification#Subscription Service|Subscription Service]] methods | * [[UNIAPI_Specification#Subscription Service|Subscription Service]] methods | ||
}} | }} | ||
Latest revision as of 13:18, 2 March 2016
Description
Returns the list of Subscription objects that belong to the user. This method can only be accessed with a valid logged token (not accessible by anonymous).
This method retrieves all the subscriptions applying some filters:
- It automatically filters the results to return only subscription types Normal (1) and AllPlaylist (4) (see SubscriptionType enumeration).
- It also filters out Subscriptions with SubscriptionPurchaseType = Provisioning Only, returning only Bottom Up and Both. (Except if applyProvisioningFilter is set to true)
Parameters
- token (String, required)
- A valid token for identifying the API session context and logged user
- offset (int, optional)
- The offset number of the returned values for this request
- limit (int, optional)
- The limit number of values for this request
- applyProvisioningFilter (bool, optional)
- ((NEW IN 2.4)
false (default value): the method will return Subscriptions with Purchase Type in (Both, ApiOnly).
true: the method will return Subscriptions with Purchase Type in (Both, ApiOnly, ProvisioningOnly).
Returns
Returns a JSON object containing an array of Subscription.
Example:
{
- "Offset": 0,
- "Limit": 100,
- "Count": 6,
- "List":
- [ Array of Subscription objects ]
}
Exceptions
- InvalidDeviceTypeException: If the token is not provided.
Caching
This method cannot be cached.
Known issues
None
Version history
| API Version Number | Change description | Changes author |
|---|---|---|
| 1.0 | Initial method design | Harley Cabral |
| 2.4 | New parameter applyProvisioningFilter | Ricardo Calvo |
See also
- SubscriptionType enumeration
- SubscriptionPurchaseType enumeration
- Subscription object
- Subscription Service methods
