GetRootRecommendationsByView - Revision history

Id02660 at 09:33, 13 July 2015

2015-07-13T09:33:31Z

Rcalvo at 18:25, 18 September 2014

2014-09-18T18:25:23Z

Rcalvo at 18:24, 18 September 2014

2014-09-18T18:24:18Z

Id02224: ContentType and CatalogType

2014-09-03T12:54:09Z

ContentType and CatalogType

Rcalvo at 21:24, 26 August 2014

2014-08-26T21:24:49Z

Rcalvo at 20:23, 26 August 2014

2014-08-26T20:23:42Z

Rcalvo at 20:13, 26 August 2014

2014-08-26T20:13:18Z

Rcalvo: Created page with "{{Api_Method_Spec| Description=Get a Recommendation from the GVP Platform. The GetRootRecommendationsByView is a ByPass method to use the OpenGVP to get all contents analysed ..."

2014-08-26T19:50:05Z

Created page with "{{Api_Method_Spec| Description=Get a Recommendation from the GVP Platform. The GetRootRecommendationsByView is a ByPass method to use the OpenGVP to get all contents analysed ..."

New page

{{Api_Method_Spec|
Description=Get a Recommendation from the GVP Platform. The GetRootRecommendationsByView is a ByPass method to use the OpenGVP to get all contents analysed and that is the recommendation for the connected user.

The suggestion is made in the OpenGVP and sent to the UNIAPI in a JSON format.
All kinds of recommendation are separated by Sources. each source represent a kind of content are recommended.

1 - MostViewed

2 - BestRated

3 - Personal

4 - Editorial

Results are presented in groups inside a ViewSet. Each group of ViewSet represent each source. In the request, a parameter SOURCE can be defined to filter the content recommended, for exemple, if the request wants only the MostViewed Recommendation, send 1 in the source parameter. This filed accept all values (1,2,3,4) separated by comma.

This method is really similar to GetNodeRecommendation, the big diference is that in the method you don't need to send an specific node (ChannelId) to get a content.

The related methods is:

- [[GetFullView]]

- [[GetNodeRecommendations]] (Similar to this)

- [[GetNodeRecommendationsByView]]

- [[GetNodeRecommendationsCombined]]

And the legacy method:

- [[GetUserRecommendations]]

Notes: The OpenGVP can be active/desactive and configured in each Environment and Instance to be used.
GetNodeRecommendations can be used in some node of channels, since from RootChannel and others.

This method only can be used by logged user.

|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=num
|ParamType=int
|ParamRequired=optional
|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=optional
|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=
}}
{{Api_Parameter|
ParamName=catalogType
|ParamType=int
|ParamRequired=optional
|ParamDescription=
}}

|Returns=
Returns a JSON object containing a JSON with the personal recommendation as [[SimpleItem]].

'''Example:'''

{
: "Content": {
:: "ViewSet": {
::: "1": [
:::: Array of [[SimpleItem]] objects
::: ]
::: "2": [
:::: Array of [[SimpleItem]] objects
::: ]
::: "3": [
:::: Array of [[SimpleItem]] objects
::: ]
::: "4": [
:::: Array of [[SimpleItem]] objects
::: ]
:: }
: }
}

|Exceptions=
* None

|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]]
* [[GetRootRecommendationsCombined]]
* [[GetUserRecommendations]]
}}

@@ Line 89: / Line 89: @@
 ::       <span style="color: #a11;">"ViewSet"</span>: {
 :::           <span style="color: #a11;">"1"</span>: [
-::::               Array of SimpleItem (OpenGVP Type) objects
+::::               Array of [[SimpleItem]] (OpenGVP Type) objects
 :::           ]
 :::           <span style="color: #a11;">"2"</span>: [
-::::               Array of SimpleItem (OpenGVP Type) objects
+::::               Array of [[SimpleItem]] (OpenGVP Type) objects
 :::           ]
 :::           <span style="color: #a11;">"3"</span>: [
-::::               Array of SimpleItem (OpenGVP Type) objects
+::::               Array of [[SimpleItem]] (OpenGVP Type) objects
 :::           ]
 :::           <span style="color: #a11;">"4"</span>: [
-::::               Array of SimpleItem (OpenGVP Type) objects
+::::               Array of [[SimpleItem]] (OpenGVP Type) objects
 :::           ]
 ::       }

@@ Line 80: / Line 80: @@
 |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 89: / Line 89: @@
 ::       <span style="color: #a11;">"ViewSet"</span>: {
 :::           <span style="color: #a11;">"1"</span>: [
-::::               Array of [[SimpleItem]] objects
+::::               Array of SimpleItem (OpenGVP Type) objects
 :::           ]
 :::           <span style="color: #a11;">"2"</span>: [
-::::               Array of [[SimpleItem]] objects
+::::               Array of SimpleItem (OpenGVP Type) objects
 :::           ]
 :::           <span style="color: #a11;">"3"</span>: [
-::::               Array of [[SimpleItem]] objects
+::::               Array of SimpleItem (OpenGVP Type) objects
 :::           ]
 :::           <span style="color: #a11;">"4"</span>: [
-::::               Array of [[SimpleItem]] objects
+::::               Array of SimpleItem (OpenGVP Type) objects
 :::           ]
 ::       }

← Older revision		Revision as of 21:24, 26 August 2014
Line 36:		Line 36:
	Notes: The OpenGVP can be active/desactive and configured in each Environment and Instance to be used.		Notes: The OpenGVP can be active/desactive and configured in each Environment and Instance to be used.
	GetNodeRecommendations can be used in some node of channels, since from RootChannel and others.		GetNodeRecommendations can be used in some node of channels, since from RootChannel and others.
−
−	~~This method only can be used by logged user.~~

@@ Line 14: / Line 14: @@
 Results are presented in groups inside a ViewSet. Each group of ViewSet represent each source. In the request, a parameter SOURCE can be defined to filter the recommended content, for exemple, if the request wants only the MostViewed Recommendation, send 1 in the source parameter. This filed accept all values (1,2,3,4) separated by comma.
 This method is really similar to GetNodeRecommendation, the big diference is that in the method you don't need to send an specific node (ChannelId) to get a content.
 The related methods are:

@@ Line 25: / Line 25: @@
 - [[GetNodeRecommendations]] (Similar to this)
-- [[GetNodeRecommendationsByView]]
+- [[GetRootRecommendationsByView]]
-- [[GetNodeRecommendationsCombined]]
+- [[GetRootRecommendationsCombined]]
 And the legacy method:

@@ Line 62: / Line 62: @@
 |ParamType=int
 |ParamRequired=optional
-|ParamDescription=
+|ParamDescription=Number that indicates the content type of the recommendation
 }}
 {{Api_Parameter|
@@ Line 68: / Line 73: @@
 |ParamType=int
 |ParamRequired=optional
-|ParamDescription=
+|ParamDescription=CatalogType: Number that indicates the sub-catalog to retrieve recommendations from (Subscrition or transactional)
 }}

@@ Line 3: / Line 3: @@
 The suggestion is made in the OpenGVP and sent to the UNIAPI in a JSON format.
-All kinds of recommendation are separated by Sources. each source represent a kind of content are recommended.
+All kinds of recommendation are separated by Sources. Each source represent a kind of content are recommended.
 - MostViewed
@@ Line 13: / Line 13: @@
 - Editorial
-Results are presented in groups inside a ViewSet. Each group of ViewSet represent each source. In the request, a parameter SOURCE can be defined to filter the content recommended, for exemple, if the request wants only the MostViewed Recommendation, send 1 in the source parameter. This filed accept all values (1,2,3,4) separated by comma.
+Results are presented in groups inside a ViewSet. Each group of ViewSet represent each source. In the request, a parameter SOURCE can be defined to filter the recommended content, for exemple, if the request wants only the MostViewed Recommendation, send 1 in the source parameter. This filed accept all values (1,2,3,4) separated by comma.
 This method is really similar to GetNodeRecommendation, the big diference is that in the method you don't need to send an specific node (ChannelId) to get a content.
-The related methods is:
+The related methods are:
 - [[GetFullView]]
@@ Line 46: / Line 46: @@
 |ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
 }}
 {{Api_Parameter|
 ParamName=num