Bureaucrats, editor
132
edits
Changes
Jump to navigation
Jump to search
Created page with "{{Api_Method_Spec| Description=This method returns the recommendations for the user. Unify openGVP recommendations method. |Parameters= {{Api_Parameter| ParamName=token |Pa..."
{{Api_Method_Spec|
Description=This method returns the recommendations for the user. Unify openGVP recommendations method.
|Parameters=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
{{Api_Parameter|
ParamName=chennelId
|ParamType=int
|ParamRequired=required
|ParamDescription=Id of the channel that wants to return the object information.
}}
{{Api_Parameter|
ParamName=num
|ParamType=int
|ParamRequired=required
|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=required
|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
}}
{{Api_Parameter|
ParamName=groupBySource
|ParamType=boolean
|ParamRequired=optional
|ParamDescription=If the groupBySource=True, the result will contain a ViewSet If the groupBySource=False, the result will contain a ItemList.
Defaults in server to: false.
}}
{{Api_Parameter|
ParamName=filterType
|ParamType=array
|ParamRequired=optional
|ParamDescription=
}}
{{Api_Parameter|
ParamName=timeFilterType
|ParamType=array
|ParamRequired=optional
|ParamDescription=
}}
|Returns=
Returns a JSON object containing a JSON with the recommendations.
'''Example:'''
{
: <span style="color: #a11;">"Content"</span>: {
:: <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
::: ]
:: }
: }
}
|Exceptions=
<span style="color: #a11;">TO BE COMPLETED</span>
|Cache=
<span style="color: #a11;">TO BE COMPLETED</span>
|KnownIssues=
* None
|VersionHistory=
<span style="color: #a11;">TO BE COMPLETED</span>
|SeeAlso=
* [[GetNodeRecommendations]]
* [[GetRootRecommendationsCombined]]
* [[GetUserRecommendations]]
}}
Description=This method returns the recommendations for the user. Unify openGVP recommendations method.
|Parameters=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
{{Api_Parameter|
ParamName=chennelId
|ParamType=int
|ParamRequired=required
|ParamDescription=Id of the channel that wants to return the object information.
}}
{{Api_Parameter|
ParamName=num
|ParamType=int
|ParamRequired=required
|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=required
|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
}}
{{Api_Parameter|
ParamName=groupBySource
|ParamType=boolean
|ParamRequired=optional
|ParamDescription=If the groupBySource=True, the result will contain a ViewSet If the groupBySource=False, the result will contain a ItemList.
Defaults in server to: false.
}}
{{Api_Parameter|
ParamName=filterType
|ParamType=array
|ParamRequired=optional
|ParamDescription=
}}
{{Api_Parameter|
ParamName=timeFilterType
|ParamType=array
|ParamRequired=optional
|ParamDescription=
}}
|Returns=
Returns a JSON object containing a JSON with the recommendations.
'''Example:'''
{
: <span style="color: #a11;">"Content"</span>: {
:: <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
::: ]
:: }
: }
}
|Exceptions=
<span style="color: #a11;">TO BE COMPLETED</span>
|Cache=
<span style="color: #a11;">TO BE COMPLETED</span>
|KnownIssues=
* None
|VersionHistory=
<span style="color: #a11;">TO BE COMPLETED</span>
|SeeAlso=
* [[GetNodeRecommendations]]
* [[GetRootRecommendationsCombined]]
* [[GetUserRecommendations]]
}}
