Difference between revisions of "GetAllSubscriptionsCatalogItems"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=Get Subscriptions catalogs items Returns the list of Cataloge Movie information of type CatalogItem. |Parameters= {{Api_Parameter| ParamNa...") |
|||
Line 33: | Line 33: | ||
|ParamType=String | |ParamType=String | ||
|ParamRequired=optional | |ParamRequired=optional | ||
− | |ParamDescription= | + | |ParamDescription=[[ProductType]] used to filter the result to return only subscriptions that contain any product matching the ProductType filter provided. If not provided it will return subscriptions with any product types. |
}} | }} | ||
Latest revision as of 16:25, 16 February 2016
Description
Get Subscriptions catalogs items
Returns the list of Cataloge Movie information of type CatalogItem.
Parameters
- token (String, required)
- A valid token for identifying the API session context. The token can be anonymous or logged.
- offset (int, optional)
- The offset number of the returned values for this request
- limit (int, optional)
- The limit number of values for this request
- typeFilter (String, optional)
- Comma separated list of SubscriptionType enumeration values (example "1,2,4") used to filter the result to return only the desired subscription types. If not provided it will return only Normal and AllPlaylist subscription types (default value = "1,4")
- childrenProductType (String, optional)
- ProductType used to filter the result to return only subscriptions that contain any product matching the ProductType filter provided. If not provided it will return subscriptions with any product types.
Returns
Returns a JSON object containing an array of CatalogItem.
Example:
{
- "Offset": 0,
- "Limit": 100,
- "Count": 6,
- "List":
- [ Array of CatalogItem objects ]
}
Exceptions
- None
Caching
This method is cached.
Known issues
- None
Version history
API Version Number | Change description | Changes author |
---|---|---|
1.0 | Initial method design | Harley Cabral |