Difference between revisions of "GetUserSubscriptions"
Jump to navigation
Jump to search
| Line 27: | Line 27: | ||
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| − | ParamName=<span style="color:# | + | ParamName=<span style="color:#7DC04E; ">bottomUpOnly </span> |
|ParamType=int | |ParamType=int | ||
|ParamRequired=optional | |ParamRequired=optional | ||
| − | |ParamDescription=<span style="color:# | + | |ParamDescription=<span style="color:#7DC04E; ">(NEW IN 2.4)</span> |
}} | }} | ||
|Returns= | |Returns= | ||
Revision as of 16:05, 2 June 2014
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 (2) (see SubscriptionType enumeration).
It also filters out Subscriptions with SubscriptionPurchaseType = Provisioning Only, returning only Bottom Up and Both.
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
- bottomUpOnly (int, optional)
- (NEW IN 2.4)
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 |
See also
- SubscriptionTypes enumeration
- SubscriptionPurchaseType enumeration
- Subscription object
- Subscription Service methods
