GetCatalogItems - Revision history

Rcalvo at 13:33, 24 March 2015

2015-03-24T13:33:54Z

Rcalvo at 13:33, 24 March 2015

2015-03-24T13:33:17Z

Rcalvo at 03:40, 20 March 2015

2015-03-20T03:40:47Z

Rcalvo at 03:39, 20 March 2015

2015-03-20T03:39:07Z

Rcalvo at 03:37, 20 March 2015

2015-03-20T03:37:15Z

Rcalvo at 03:30, 20 March 2015

2015-03-20T03:30:14Z

Rcalvo: 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..."

2015-03-20T03:23:59Z

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..."

New page

{{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 filter out everything. Also will take into account the ordering of the elements defined in the MIB Channel Editorial Contents block.

'''Important: It won't filter by Adult property, as adult contents must only be linked to adult channels.'''

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=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
{{Api_Parameter|
ParamName=offset
|ParamType=int
|ParamRequired=optional
|ParamDescription=The offset number of the returned values for this request
}}
{{Api_Parameter|
ParamName=limit
|ParamType=int
|ParamRequired=optional
|ParamDescription=The limit number of values for this request
}}
{{Api_Parameter|
ParamName=channelId
|ParamType=int
|ParamRequired=required
|ParamDescription=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

|Cache=
This method is cached.

|KnownIssues=
None

|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 3.0
{{!}} Initial method design
{{!}} Ricardo Calvo
{{!}}}

|SeeAlso=
* [[GetChannelSimpleMovies]]

}}

@@ Line 6: / Line 6: @@
 * Movies: take into account movie availability, movie status and availability window.
 * Subscriptions:
-     ** Take into account Start Date and End Date and Status.
+** Take into account Start Date and End Date and Status.
-     ** Take into account Subscription type (TEF, NONTEF, Both).
+** Take into account Subscription type (TEF, NONTEF, Both).
 * Live Channels: Status (Active) and live channel device availability

@@ Line 5: / Line 5: @@
 * Movies: take into account movie availability, movie status and availability window.
-* Subscriptions: take into account Start Date and End Date and Status
+* Subscriptions:
 * Live Channels: Status (Active) and live channel device availability
 |Parameters=
 {{Api_Parameter|

@@ Line 49: / Line 49: @@
 :      "ImageUrl": null,
 :      "ResizableImages": [
-::        {
+::        Array of [[Image]]
 :      ],
 :      "ExtraMetadata": {

@@ Line 54: / Line 54: @@
 :      ],
 :      "ExtraMetadata": {
-:        Object of [[ExtraMetaData]]
+::        Object of [[ExtraMetaData]]
 :      },
 :      "StartDate": -2208992400,

@@ Line 1: / Line 1: @@
 {{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
 |Parameters=

@@ Line 1: / Line 1: @@
 {{Api_Method_Spec|
 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
+* Movies: take into account movie availability, movie status and availability window.
-- Live Channels: Status (Active) and live channel device availability
+* Subscriptions: take into account Start Date and End Date and Status
 |Parameters=
@@ Line 14: / Line 16: @@
 }}
 {{Api_Parameter|
-ParamName=offset
+ParamName=catalogItemTypeId
 |ParamType=int
-|ParamRequired=optional
+|ParamRequired=required
-|ParamDescription=The offset number of the returned values for this request
+|ParamDescription=Id type of the catalog desired
 }}
 {{Api_Parameter|
-ParamName=limit
+ParamName=catalogItemIds
-|ParamType=int
+|ParamType=String
 |ParamRequired=required
-|ParamDescription=The channel id that want to return the editorial content registered inside then.
+|ParamDescription=Array of catalogItemIds desired
 }}
 |Returns=
-Returns a JSON object containing an array of [[EditorialContent]].
+Returns a JSON object containing an array of [[CatalogItem]].
 '''Example:'''
+{
-:   "Offset": 0,
+:      "CatalogItemId": 565,
-:   "Limit": 100,
+:      "CatalogItemType": 1,
-:   "Count": 6,
+:      "Title": "Juego asesino",
-:   "List":
+:      "Keywords": null,
-::        [ Array of [[EditorialContent]] List ]
+:      "Cast": "James Spader,Keanu Reeves,Marisa Tomei,Joe Charbanic ",
+}