GetRecoms

Description

This method returns the recommendations for the user. Unify openGVP recommendations method.

Parameters

• token (String, required)

A valid token for identifying the API session context. The token can be anonymous or logged.

• chennelId (int, required)

Id of the channel that wants to return the object information.

• num (int, required)

Quantity of recommendation wants to be returned. Each source will return the quantity specified by num parameter.

• sources (int, required)

Number separated by comma that represent a kind of content wants to be filter the result. (1 - MostViewed, 2 - BestRated, 3 - Personal, 4 - Editorial)

• contentType (int, optional)

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

• catalogType (int, optional)

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

• groupBySource (boolean, optional)

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.

• filterType (array, optional)

• timeFilterType (array, optional)

Returns

Returns a JSON object containing a JSON with the recommendations.

Example:

{

"Content": {

"ViewSet": {

"1": [

Array of SimpleItem (OpenGVP Type) objects

]

"2": [

Array of SimpleItem (OpenGVP Type) objects

]

"3": [

Array of SimpleItem (OpenGVP Type) objects

]

"4": [

Array of SimpleItem (OpenGVP Type) objects

]

}

}

}

Exceptions

TO BE COMPLETED

Caching

This method is not cached.

Known issues

• None

Version history

TO BE COMPLETED

See also

• GetNodeRecommendations
• GetRootRecommendationsCombined
• GetUserRecommendations