Bureaucrats, editor
349
edits
Changes
Jump to navigation
Jump to search
This method only can be used by logged user.
no edit summary
The suggestion is made in the OpenGVP and sent to the UNIAPI in a JSON format.
All kinds of recommendation are separated by Sources. each Each source represent a kind of content are recommended.
1 - MostViewed
4 - Editorial
Results are presented in groups inside a ViewSet. Each group of ViewSet represent each source. In the request, a parameter SOURCE can be defined to filter the recommended content recommended, for exemple, if the request wants only the MostViewed Recommendation, send 1 in the source parameter. This filed accept all values (1,2,3,4) separated by comma.
This method is really similar to GetNodeRecommendation, the big diference is that in the method you don't need to send an specific node (ChannelId) to get a content.
The related methods isare:
- [[GetFullView]]
- [[GetNodeRecommendations]] (Similar to this)
- [[GetNodeRecommendationsByViewGetRootRecommendationsByView]]
- [[GetNodeRecommendationsCombinedGetRootRecommendationsCombined]]
And the legacy method:
Notes: The OpenGVP can be active/desactive and configured in each Environment and Instance to be used.
GetNodeRecommendations can be used in some node of channels, since from RootChannel and others.
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
{{Api_Parameter|
ParamName=num
|ParamType=int
|ParamRequired=optional
|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|
|ParamType=int
|ParamRequired=optional
|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 a JSON object containing a JSON with the personal recommendation as [[SimpleItem]].
'''Example:'''
:: <span style="color: #a11;">"ViewSet"</span>: {
::: <span style="color: #a11;">"1"</span>: [
:::: Array of [[SimpleItem]] (OpenGVP Type) objects
::: ]
::: <span style="color: #a11;">"2"</span>: [
:::: Array of [[SimpleItem]] (OpenGVP Type) objects
::: ]
::: <span style="color: #a11;">"3"</span>: [
:::: Array of [[SimpleItem]] (OpenGVP Type) objects
::: ]
::: <span style="color: #a11;">"4"</span>: [
:::: Array of [[SimpleItem]] (OpenGVP Type) objects
::: ]
:: }
