Difference between revisions of "GetCatalogItems"

From Gvp-public
Jump to navigation Jump to search
(Created page with "{{Api_Method_Spec| Description=This method has to return an ordered list of EditorialContent. This method will take into account the Start and End Date of the Content, to...")
 
Line 1: Line 1:
 
{{Api_Method_Spec|
 
{{Api_Method_Spec|
Description=This method has to return an ordered list of [[EditorialContent]].
+
Description= New method in UNIAPI to retrieve the Catalog Items based on the IDs for a specific [[CatalogItemType]].
 
+
Take into account the device availability
This method will take into account the Start and End Date of the Content, to filter out everything. Also will take into account the ordering of the elements defined in the MIB Channel Editorial Contents block.
+
- Movies: take into account movie availability, movie status and availability window.
 
+
- Subscriptions: take into account Start Date and End Date and Status
'''Important: It won't filter by Adult property, as adult contents must only be linked to adult channels.'''
+
- Live Channels: Status (Active) and live channel device availability
 
 
It will return ALL the EditorialContents (either they have catalog item associated or not; or either the editorial content has an image linked or not).
 
  
 
|Parameters=
 
|Parameters=

Revision as of 03:30, 20 March 2015

Description

New method in UNIAPI to retrieve the Catalog Items based on the IDs for a specific CatalogItemType. Take into account the device availability - Movies: take into account movie availability, movie status and availability window. - Subscriptions: take into account Start Date and End Date and Status - Live Channels: Status (Active) and live channel device availability

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
  • channelId (int, required)
The channel id that want to return the editorial content registered inside then.


Returns

Returns a JSON object containing an array of EditorialContent.

Example:

{

"Offset": 0,
"Limit": 100,
"Count": 6,
"List":
[ Array of EditorialContent List ]

}


Exceptions

None


Caching

This method is cached.


Known issues

None


Version history

API Version Number Change description Changes author
3.0 Initial method design Ricardo Calvo


See also