GetCatalogItems

From Gvp-public
Jump to navigation Jump to search

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.
    • Take into account Subscription type (TEF, NONTEF, Both).
  • Live Channels: Status (Active) and live channel device availability

The method accept just one type of Catalog per request and multiple CatalogId's as a list. It means that the user can't request ID's from different Catalog Types.

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": [
Array 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


See also