GetFullView - Revision history

Id02660 at 09:33, 13 July 2015

2015-07-13T09:33:53Z

Rcalvo at 14:34, 18 September 2014

2014-09-18T14:34:07Z

Rcalvo at 17:17, 17 September 2014

2014-09-17T17:17:21Z

Id02224: contentType and CatalogType info

2014-09-03T12:53:18Z

contentType and CatalogType info

Rcalvo: Created page with "{{Api_Method_Spec| Description=Call to provide a flat list of the full contents for one VIEW (just one Source) in a node. Note that the view is not paged, i.e. all items avail..."

2014-08-27T22:23:45Z

Created page with "{{Api_Method_Spec| Description=Call to provide a flat list of the full contents for one VIEW (just one Source) in a node. Note that the view is not paged, i.e. all items avail..."

New page

{{Api_Method_Spec|
Description=Call to provide a flat list of the full contents for one VIEW (just one Source) in a node. Note that the view is not paged, i.e. all items available in the view will be returned.
The client is then free to visualize it through any suitable means (paged views, scrolling, etc).

The Num parameter indicates how many elements should be returned. The actual amount returned may be less (if the view contains less than Num items). There is a cap to the maximum value accepted in Num, currently set at 50 (requests for larger amounts will be silently cut to that limit), because the view does not contain more than those items.

|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=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=source
|ParamType=int
|ParamRequired=optional
|ParamDescription=Number that represent a kind of content wants to be filter the result. Allowed only one of then. (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:'''

{
: <span style="color: #a11;">"Content"</span>: {
:: <span style="color: #a11;">"ItemList"</span>: [
::: 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=
* [[GetRootRecommendationsByView]]
* [[GetRootRecommendationsCombined]]
* [[GetUserRecommendations]]
}}

@@ Line 67: / Line 67: @@
 :    <span style="color: #a11;">"Content"</span>: {
 ::       <span style="color: #a11;">"ItemList"</span>:  [
-:::               Array of SimpleItem objects (OpenGVP type)
+:::               Array of [[SimpleItem]] objects (OpenGVP type)
 ::      ]
 :    }

@@ Line 31: / Line 31: @@
 |ParamType=int
 |ParamRequired=optional
-|ParamDescription=Number that represent a kind of content wants to be filter the result. Allowed only one of then. (1 - MostViewed, 2 - BestRated, 3 - Personal, 4 - Editorial).
+|ParamDescription=Number that represent a kind of content wants to be filter the result. Allowed only one of then.
 }}
 {{Api_Parameter|