GetUserRecommendations - Revision history

Rcalvo at 20:34, 23 March 2015

2015-03-23T20:34:59Z

Rcalvo at 20:33, 23 March 2015

2015-03-23T20:33:51Z

Rcalvo at 20:24, 23 March 2015

2015-03-23T20:24:02Z

Rcalvo at 20:23, 23 March 2015

2015-03-23T20:23:43Z

Rcalvo at 20:22, 23 March 2015

2015-03-23T20:22:43Z

Rcalvo at 20:22, 23 March 2015

2015-03-23T20:22:24Z

Rcalvo at 19:25, 18 September 2014

2014-09-18T19:25:22Z

Rcalvo at 21:42, 27 August 2014

2014-08-27T21:42:06Z

Rcalvo at 21:40, 27 August 2014

2014-08-27T21:40:11Z

Rcalvo: 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 ‘..."

2014-08-27T21:39:25Z

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 ‘..."

New page

{{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]]
}}

@@ Line 1: / Line 1: @@
 {{Api_Method_Spec|
 Description=
-<div style="background-color:red; padding:10px;">GVP 3.0 - DEPRECATED in next versions: This method will be migrated to GetChannelEditorialContents</div>
+<div style="background-color:red; padding:10px;">
 '''Since the GVP 3.0 this method will use the GetChannelEditorialContent to return the desired content against broken old legacy devices.'''
 If a user requests Editorial Recommendation and Open GVP is not connected or fails (we have a fallback in UNIAPI for this), we will look into the EditorialContents associated with the Channel that have GVP_MOVIES associated.
 Only movies with availability (Except Episodes, episodes are not returned)

@@ Line 2: / Line 2: @@
 Description=
 <div style="background-color:red; padding:10px;">GVP 3.0 - DEPRECATED in next versions: This method will be migrated to GetChannelEditorialContents</div>
 If a user requests Editorial Recommendation and Open GVP is not connected or fails (we have a fallback in UNIAPI for this), we will look into the EditorialContents associated with the Channel that have GVP_MOVIES associated.
 <span style="text-decoration:line-through">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.

@@ Line 115: / Line 115: @@
 |SeeAlso=
 * [[GetChannelEditorialContents]]
-* [[EditorialContents]]
+* [[EditorialContent]]
 * [[GetNodeRecommendations]]

@@ Line 12: / Line 12: @@
 <span style="text-decoration:line-through">'''Workaround / special error code:'''
-Has been detected that sometimes it’s impossible to provide recommendations using OpenGVP. These situations are:
+<span style="text-decoration:line-through">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
+•	<span style="text-decoration:line-through">Trying to get recommendations for a only series channel
-•	Trying to get recommendations for a just created user, not present yet in opengvp data.
+•	<span style="text-decoration:line-through">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).</span>
+<span style="text-decoration:line-through">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).</span>

@@ Line 114: / Line 114: @@
 |SeeAlso=
 * [[GetNodeRecommendations]]
 * [[GetRootRecommendationsByView]]
 * [[GetUserRecommendations]]
 }}

@@ Line 70: / Line 70: @@
 |Returns=
-Returns a JSON object containing a JSON with the personal recommendation as [[SimpleItem]].
+Returns a JSON object containing a JSON with the personal recommendation.
 '''Example:'''
@@ Line 78: / Line 78: @@
 ::       <span style="color: #a11;">"ItemList"</span>: [
 :::           {
-::::               Array of [[SimpleItem]] objects + Source properties.
+::::               Array of SimpleItem (OpenGVP type) objects + Source properties.
 :::           }
 ::       ]

@@ Line 40: / Line 40: @@
 |ParamType= int
 |ParamRequired=required
-|ParamDescription=
+|ParamDescription=Quantity of MostView type wants to be returned.
 }}
 {{Api_Parameter|
@@ Line 46: / Line 46: @@
 |ParamType= int
 |ParamRequired=required
-|ParamDescription=
+|ParamDescription=Quantity of BestRated type wants to be returned.
 }}
 {{Api_Parameter|
@@ Line 52: / Line 52: @@
 |ParamType= int
 |ParamRequired=required
-|ParamDescription=
+|ParamDescription=Quantity of PersonalUser type wants to be returned.
 }}
 {{Api_Parameter|
@@ Line 58: / Line 58: @@
 |ParamType= int
 |ParamRequired=required
-|ParamDescription=
+|ParamDescription=Quantity of Editorial type wants to be returned.
 }}
 {{Api_Parameter|