Difference between revisions of "GetFullView"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=Call to provide a flat list of the full contents for one VIEW (just one Source) in a node. Note that the view is not paged, i.e. all items avail...") |
|||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 31: | Line 31: | ||
|ParamType=int | |ParamType=int | ||
|ParamRequired=optional | |ParamRequired=optional | ||
| − | |ParamDescription=Number that represent a kind of content wants to be filter the result. Allowed only one of then. | + | |ParamDescription=Number that represent a kind of content wants to be filter the result. Allowed only one of then. |
| + | 1 - MostViewed | ||
| + | 2 - BestRated | ||
| + | 3 - Personal | ||
| + | 4 - Editorial | ||
| + | |||
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| Line 37: | Line 42: | ||
|ParamType=int | |ParamType=int | ||
|ParamRequired=optional | |ParamRequired=optional | ||
| − | |ParamDescription= | + | |ParamDescription=Number that indicates the content type of the recommendation |
| + | 0 - Any: It returns both Movie and Series | ||
| + | 1 - Movie: Used for movies | ||
| + | 2 - Series: Used for TV series | ||
| + | |||
| + | |||
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| Line 43: | Line 53: | ||
|ParamType=int | |ParamType=int | ||
|ParamRequired=optional | |ParamRequired=optional | ||
| − | |ParamDescription= | + | |ParamDescription=CatalogType: Number that indicates the sub-catalog to retrieve recommendations from (Subscrition or transactional) |
| + | 0 - Any: Transactional or subscription (hired by the user). Default for getNodeRecommendations and GetFullView | ||
| + | 1 - Subscription: Contents from subscriptions rented by the user (and inside the subscription sub-catalog). Default for GetRotRecommendationsCombined and GetRootREcommendationsByView | ||
| + | 2 - Transactional: Contents from transactional sub-catalog | ||
}} | }} | ||
|Returns= | |Returns= | ||
| − | Returns a JSON object containing a JSON with the personal recommendation | + | Returns a JSON object containing a JSON with the personal recommendation. |
'''Example:''' | '''Example:''' | ||
| Line 54: | Line 67: | ||
: <span style="color: #a11;">"Content"</span>: { | : <span style="color: #a11;">"Content"</span>: { | ||
:: <span style="color: #a11;">"ItemList"</span>: [ | :: <span style="color: #a11;">"ItemList"</span>: [ | ||
| − | ::: Array of [[SimpleItem]] objects | + | ::: Array of [[SimpleItem]] objects (OpenGVP type) |
:: ] | :: ] | ||
: } | : } | ||
Latest revision as of 09:33, 13 July 2015
Description
Call to provide a flat list of the full contents for one VIEW (just one Source) in a node. Note that the view is not paged, i.e. all items available in the view will be returned. The client is then free to visualize it through any suitable means (paged views, scrolling, etc).
The Num parameter indicates how many elements should be returned. The actual amount returned may be less (if the view contains less than Num items). There is a cap to the maximum value accepted in Num, currently set at 50 (requests for larger amounts will be silently cut to that limit), because the view does not contain more than those items.
Parameters
- token (String, required)
- A valid token for identifying the API session context. The token can be anonymous or logged.
- channelId (int, required)
- A number of a channel Id that wants to get a recommendation.
- num (int, optional)
- Quantity of recommendation wants to be returned. Each source will return the quantity specified by num parameter.
- source (int, optional)
- Number that represent a kind of content wants to be filter the result. Allowed only one of then.
1 - MostViewed 2 - BestRated 3 - Personal 4 - Editorial
- contentType (int, optional)
- Number that indicates the content type of the recommendation
0 - Any: It returns both Movie and Series 1 - Movie: Used for movies 2 - Series: Used for TV series
- catalogType (int, optional)
- CatalogType: Number that indicates the sub-catalog to retrieve recommendations from (Subscrition or transactional)
0 - Any: Transactional or subscription (hired by the user). Default for getNodeRecommendations and GetFullView 1 - Subscription: Contents from subscriptions rented by the user (and inside the subscription sub-catalog). Default for GetRotRecommendationsCombined and GetRootREcommendationsByView 2 - Transactional: Contents from transactional sub-catalog
Returns
Returns a JSON object containing a JSON with the personal recommendation.
Example:
{
- "Content": {
- "ItemList": [
- Array of SimpleItem objects (OpenGVP type)
- ]
- "ItemList": [
- }
}
Exceptions
- None
Caching
This method is not cached.
Known issues
- None
Version history
| API Version Number | Change description | Changes author |
|---|---|---|
| 2.3 | Initial method design | Harley Cabral |
