Difference between revisions of "GetCatalogItems"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
Description= New method in UNIAPI to retrieve the Catalog Items based on the IDs for a specific [[CatalogItemType]]. | Description= New method in UNIAPI to retrieve the Catalog Items based on the IDs for a specific [[CatalogItemType]]. | ||
| + | |||
Take into account the device availability | 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= | |Parameters= | ||
| Line 14: | Line 16: | ||
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| − | ParamName= | + | ParamName=catalogItemTypeId |
|ParamType=int | |ParamType=int | ||
| − | |ParamRequired= | + | |ParamRequired=required |
| − | |ParamDescription= | + | |ParamDescription=Id type of the catalog desired |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| − | ParamName= | + | ParamName=catalogItemIds |
| − | |ParamType= | + | |ParamType=String |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|ParamRequired=required | |ParamRequired=required | ||
| − | |ParamDescription= | + | |ParamDescription=Array of catalogItemIds desired |
}} | }} | ||
| − | |||
|Returns= | |Returns= | ||
| − | Returns a JSON object containing an array of [[ | + | Returns a JSON object containing an array of [[CatalogItem]]. |
'''Example:''' | '''Example:''' | ||
{ | { | ||
| − | : | + | : "CatalogItemId": 565, |
| − | : | + | : "CatalogItemType": 1, |
| − | : | + | : "Title": "Juego asesino", |
| − | : | + | : "Keywords": null, |
| − | :: [ | + | : "Cast": "James Spader,Keanu Reeves,Marisa Tomei,Joe Charbanic ", |
| + | : "IsAdult": false, | ||
| + | : "AgeRating": "NR 18", | ||
| + | : "T9Title": "5834602737466", | ||
| + | : "Genres": "Tenis", | ||
| + | : "Images": [ | ||
| + | :: Array of [[Image]] | ||
| + | : ], | ||
| + | : "ImageUrl": null, | ||
| + | : "ResizableImages": [ | ||
| + | :: { | ||
| + | ::: Object of [[Image]] | ||
| + | :: } | ||
| + | : ], | ||
| + | : "ExtraMetadata": { | ||
| + | : Object of [[ExtraMetaData]] | ||
| + | : }, | ||
| + | : "StartDate": -2208992400, | ||
| + | : "EndDate": 2524604400, | ||
| + | : "ShortDescription": "El agente del FBI Joel Campbell ha sido uno de los mejores cazadores de asesinos en serie de Los Ángeles. Un año después de retirarse, en el edificio de apartamentos en el que vive, una mujer aparece asesinada.", | ||
| + | : "ProductType": [[ProductType]], | ||
| + | : "Quality": 2, | ||
| + | : "StatusDate": 1262300400 | ||
} | } | ||
Revision as of 03:37, 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.
- catalogItemTypeId (int, required)
- Id type of the catalog desired
- catalogItemIds (String, required)
- Array of catalogItemIds desired
Returns
Returns a JSON object containing an array of CatalogItem.
Example:
{
- "CatalogItemId": 565,
- "CatalogItemType": 1,
- "Title": "Juego asesino",
- "Keywords": null,
- "Cast": "James Spader,Keanu Reeves,Marisa Tomei,Joe Charbanic ",
- "IsAdult": false,
- "AgeRating": "NR 18",
- "T9Title": "5834602737466",
- "Genres": "Tenis",
- "Images": [
- Array of Image
- ],
- "ImageUrl": null,
- "ResizableImages": [
- {
- Object of Image
- }
- {
- ],
- "ExtraMetadata": {
- Object of ExtraMetaData
- },
- "StartDate": -2208992400,
- "EndDate": 2524604400,
- "ShortDescription": "El agente del FBI Joel Campbell ha sido uno de los mejores cazadores de asesinos en serie de Los Ángeles. Un año después de retirarse, en el edificio de apartamentos en el que vive, una mujer aparece asesinada.",
- "ProductType": ProductType,
- "Quality": 2,
- "StatusDate": 1262300400
}
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 |
