GetUserRecommendations
Description
GVP 3.0 - DEPRECATED in next versions: This method will be migrated to GetChannelEditorialContents.
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)
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
- token (String, required)
- A valid token for identifying the API session context. The token can be anonymous or logged.
- channelId (int, required)
- A number of a channel Id that wants to get a recommendation.
- highlightType (highlightType, required)
- mostView (int, required)
- Quantity of MostView type wants to be returned.
- bestRated (int, required)
- Quantity of BestRated type wants to be returned.
- personalUser (int, required)
- Quantity of PersonalUser type wants to be returned.
- editorial (int, required)
- Quantity of Editorial type wants to be returned.
- mibRecommendations (int, optional)
Returns
Returns a JSON object containing a JSON with the personal recommendation.
Example:
{
- "Content": {
- "ItemList": [
- {
- Array of SimpleItem (OpenGVP type) objects + Source properties.
- }
- {
- ]
- "ItemList": [
- }
}
Exceptions
Caching
This method is not cached.
Known issues
- None
Version history
| API Version Number | Change description | Changes author |
|---|---|---|
| 2.3 | Initial method design | Harley Cabral |
