editor
725
edits
Changes
Jump to navigation
Jump to search
Created page with "{{Api_Method_Spec| Description=This is an equivalent call to the ‘classic’ one in UNIAPI, it will be used by GVP when receiving a GetUserRecommendations request from a ‘..."
{{Api_Method_Spec|
Description=This is an equivalent call to the ‘classic’ one in UNIAPI, it will be used by GVP when receiving a GetUserRecommendations request from a ‘legacy’ device.
One important feature for this call is that it works with a reduced overall content set, restricted to the items that are available in all devices calling this backwards-compatible API (because old-style devices forbid showing items that cannot be played on the device).
'''Workaround / special error code:'''
Has been detected that sometimes it’s impossible to provide recommendations using OpenGVP. These situations are:
• Trying to get recommendations for a only series channel
• Trying to get recommendations for a just created user, not present yet in opengvp data.
In these situations this operation will return a status code 3 (method unavailable). When this method is called through UNIAPI proxy call, this error code should be interpreted by LabOne as using old recommendation method logic to provide recommendations to caller. In other words, when status code 3 is returned by this method, UNIAPI getUserRecommendations method should have the same behavior that before (pre OpenGVP).
|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=channelId
|ParamType=int
|ParamRequired=required
|ParamDescription=A number of a channel Id that wants to get a recommendation.
}}
{{Api_Parameter|
ParamName=highlightType
|ParamType= highlightType
|ParamRequired=required
|ParamDescription=
}}
{{Api_Parameter|
ParamName= mostView
|ParamType= int
|ParamRequired=required
|ParamDescription=
}}
{{Api_Parameter|
ParamName= bestRated
|ParamType= int
|ParamRequired=required
|ParamDescription=
}}
{{Api_Parameter|
ParamName= personalUser
|ParamType= int
|ParamRequired=required
|ParamDescription=
}}
{{Api_Parameter|
ParamName= editorial
|ParamType= int
|ParamRequired=required
|ParamDescription=
}}
{{Api_Parameter|
ParamName= mibRecommendations
|ParamType= int
|ParamRequired=optional
|ParamDescription=
}}
|Returns=
Returns a JSON object containing a JSON with the personal recommendation as [[SimpleItem]].
'''Example:'''
{
: <span style="color: #a11;">"Content"</span>: {
:: <span style="color: #a11;">"ItemList"</span>: [
::: {
:::: Array of [[SimpleItem]] objects + Source properties.
::: }
:: ]
: }
}
|Exceptions=
* [[InvalidChannelException]]
|Cache=
This method is not cached.
|KnownIssues=
* None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 2.3
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}}
|SeeAlso=
* [[GetNodeRecommendations]]
* [[GetRootRecommendationsByView]]
* [[GetUserRecommendations]]
}}
Description=This is an equivalent call to the ‘classic’ one in UNIAPI, it will be used by GVP when receiving a GetUserRecommendations request from a ‘legacy’ device.
One important feature for this call is that it works with a reduced overall content set, restricted to the items that are available in all devices calling this backwards-compatible API (because old-style devices forbid showing items that cannot be played on the device).
'''Workaround / special error code:'''
Has been detected that sometimes it’s impossible to provide recommendations using OpenGVP. These situations are:
• Trying to get recommendations for a only series channel
• Trying to get recommendations for a just created user, not present yet in opengvp data.
In these situations this operation will return a status code 3 (method unavailable). When this method is called through UNIAPI proxy call, this error code should be interpreted by LabOne as using old recommendation method logic to provide recommendations to caller. In other words, when status code 3 is returned by this method, UNIAPI getUserRecommendations method should have the same behavior that before (pre OpenGVP).
|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=channelId
|ParamType=int
|ParamRequired=required
|ParamDescription=A number of a channel Id that wants to get a recommendation.
}}
{{Api_Parameter|
ParamName=highlightType
|ParamType= highlightType
|ParamRequired=required
|ParamDescription=
}}
{{Api_Parameter|
ParamName= mostView
|ParamType= int
|ParamRequired=required
|ParamDescription=
}}
{{Api_Parameter|
ParamName= bestRated
|ParamType= int
|ParamRequired=required
|ParamDescription=
}}
{{Api_Parameter|
ParamName= personalUser
|ParamType= int
|ParamRequired=required
|ParamDescription=
}}
{{Api_Parameter|
ParamName= editorial
|ParamType= int
|ParamRequired=required
|ParamDescription=
}}
{{Api_Parameter|
ParamName= mibRecommendations
|ParamType= int
|ParamRequired=optional
|ParamDescription=
}}
|Returns=
Returns a JSON object containing a JSON with the personal recommendation as [[SimpleItem]].
'''Example:'''
{
: <span style="color: #a11;">"Content"</span>: {
:: <span style="color: #a11;">"ItemList"</span>: [
::: {
:::: Array of [[SimpleItem]] objects + Source properties.
::: }
:: ]
: }
}
|Exceptions=
* [[InvalidChannelException]]
|Cache=
This method is not cached.
|KnownIssues=
* None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 2.3
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}}
|SeeAlso=
* [[GetNodeRecommendations]]
* [[GetRootRecommendationsByView]]
* [[GetUserRecommendations]]
}}
