Difference between revisions of "GetTopRecommendedContents"
m |
|||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | {{Deprecated|Message=This method has been deprecated in GVP 3.0. Please use [[GetChannelEditorialContents]] and [[GetCatalogItems]] instead}} | ||
| + | |||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
Description= | Description= | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
This method will return all the EditorialContents in a CatalogItem format if have GVP_MOVIES, GVP_SUBSCRIPTIONS, etc associated, returning the catalog item ID and Type filled. In case there is not any media type associated, the method will return 0/0 as catalog item id and type; but the other properties fulfilled, i.e. the "external links" as ExtraMetadata and/or the image (banner) linked to the EditorialContent. | This method will return all the EditorialContents in a CatalogItem format if have GVP_MOVIES, GVP_SUBSCRIPTIONS, etc associated, returning the catalog item ID and Type filled. In case there is not any media type associated, the method will return 0/0 as catalog item id and type; but the other properties fulfilled, i.e. the "external links" as ExtraMetadata and/or the image (banner) linked to the EditorialContent. | ||
Images will contain the images associated to the MediaType that is associated to the EditorialContent. | Images will contain the images associated to the MediaType that is associated to the EditorialContent. | ||
In case we have more than one image (banner) linked to the EditorialContent, we will just take the first one (lowest ID) to fulfill the ImageUrl property. | In case we have more than one image (banner) linked to the EditorialContent, we will just take the first one (lowest ID) to fulfill the ImageUrl property. | ||
| + | |||
| + | Consideration: | ||
| + | |||
| + | *Return, Movies (Serie, season, episode or movie type), Subscription and LiveChannel. (Does not take into account the movie.availability, subscription.active, etc...) | ||
| + | *Only the first 10 will be returned. | ||
| + | *Some items can be removed from returned list based on adultFilter rules. | ||
<br> | <br> | ||
| Line 83: | Line 83: | ||
{{!}} Initial method design | {{!}} Initial method design | ||
{{!}} Harley Cabral | {{!}} Harley Cabral | ||
| + | {{!}}- | ||
| + | ! 3.0 | ||
| + | {{!}} Method deprecated | ||
| + | {{!}} Francisco Milagro | ||
{{!}}} | {{!}}} | ||
| + | |||
|SeeAlso= | |SeeAlso= | ||
*[[GetChannelEditorialContents]] | *[[GetChannelEditorialContents]] | ||
*[[EditorialContent]] Object | *[[EditorialContent]] Object | ||
| + | *[[GetCatalogItems]] | ||
}} | }} | ||
Latest revision as of 09:16, 9 February 2016
This method has been deprecated in GVP 3.0. Please use GetChannelEditorialContents and GetCatalogItems instead
Description
This method will return all the EditorialContents in a CatalogItem format if have GVP_MOVIES, GVP_SUBSCRIPTIONS, etc associated, returning the catalog item ID and Type filled. In case there is not any media type associated, the method will return 0/0 as catalog item id and type; but the other properties fulfilled, i.e. the "external links" as ExtraMetadata and/or the image (banner) linked to the EditorialContent.
Images will contain the images associated to the MediaType that is associated to the EditorialContent. In case we have more than one image (banner) linked to the EditorialContent, we will just take the first one (lowest ID) to fulfill the ImageUrl property.
Consideration:
- Return, Movies (Serie, season, episode or movie type), Subscription and LiveChannel. (Does not take into account the movie.availability, subscription.active, etc...)
- Only the first 10 will be returned.
- Some items can be removed from returned list based on adultFilter rules.
Return the top recommended from a channel (Editorial content from 1-10)
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)
- Id of a channel that wants the result
- adultFilter (AdultFilterType, optional)
- Type to filter the result using adult filter
Returns
Returns a JSON object containing an array of CatalogItem object.
Example:
{
- "Offset": 0,
- "Limit": 100,
- "Count": 10,
- "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 |
| 3.0 | Method deprecated | Francisco Milagro |
