Bureaucrats, editor
349
edits
Changes
Jump to navigation
Jump to search
The related methods is:
All these methods are from OpenGVP, and they use that BackendAPI to get all contents and analyse that to return some recommendation. So, the UNIAPI is like a proxy between the client device and the OpenGVP by these four methods.
: <span style="color: #a11;">"StatusCode"</span>: <span style="color: #164;">0</span>,
: <span style="color: #a11;">"Severity"</span>: <span style="color: #164;">1</span>,
: <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"OK"</span>,
no edit summary
{{Api_Method_Spec|
Description=Get a Recommendation from the GVP Platform using many data information . The GetNodeRecommendations is a ByPass method to use the OpenGVP to get a personal content to present all contents analysed and that is the recommendation for the connected user. This method was created The suggestion is made in the OpenGVP and sent to analyse all the UNIAPI in a JSON format.All kinds of recommendation are separated by Sources. Each source represent a kind of content that are recommended. 1 - MostViewed 2 - BestRated 3 - Personal 4 - Editorial Results are presented in groups inside a ViewSet. Each group of ViewSet represent each source. In the GVP and find request, a parameter SOURCE can be defined to filter the better recommended content to suggest , for exemple, if the user to watchrequest wants only the MostViewed Recommendation, send 1 in the source parameter. This filed accept all values (1,2,3,4) separated by comma. The related methods are:
- [[GetFullView]]
- [[GetNodeRecommendations]]
- [[GetNodeRecommendationsByViewGetRootRecommendationsByView]]
- [[GetNodeRecommendationsCombinedGetRootRecommendationsCombined]]
And the legacy method:
- [[GetUserRecommendations]]
Notes: The OpenGVP should can be active /desactive and configured in each Environment and Instance to be used.GetNodeRecommendations only can be used in some node of channels, so it can't be used by since from RootChannel. This method only can be used by logged userand others.
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
{{Api_Parameter|
ParamName=channelId
|ParamType=int
|ParamRequired=required
|ParamDescription=A number of a channel Id that wants to get a recommendation.
}}
{{Api_Parameter|
ParamName=num
|ParamType=int
|ParamRequired=optional
|ParamDescription=Quantity of recommendation wants to be returned. Each source will return the quantity specified by num parameter.
}}
{{Api_Parameter|
ParamName=sources
|ParamType=int
|ParamRequired=optional
|ParamDescription=Number separated by comma that represent a kind of content wants to be filter the result. (1 - MostViewed, 2 - BestRated, 3 - Personal, 4 - Editorial)
}}
{{Api_Parameter|
ParamName=contentType
|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|
ParamName=catalogType
|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;">"Content"</span>: {
:: <span style="color: #219a11;">"ViewSet"</span>: {::: <span style="color: #a11;">"1"</span>: [:::: Array of [[SimpleItem]] objects::: ]::: <span style="color: #a11;">"2"</span>: [:::: Array of [[SimpleItem]] objects::: ]::: <span style="color: #a11;">"3"</span>: [:::: Array of [[SimpleItem]] objects::: ]::: <span style="color: #a11;">"4"</span>: [:::: Array of [[SimpleItem]] objects::: ]:: }
: }
}
|Exceptions=
! Changes author
{{!}}- valign="top"
! 2.43
{{!}} Initial method design
{{!}} Harley Cabral
|SeeAlso=
* [[GetRootRecommendationsByView]]
* [[GetRootRecommendationsCombined]]
* [[GetUserRecommendations]]
}}
