SearchContent - Revision history

Pcl245 at 16:21, 16 February 2016

2016-02-16T16:21:06Z

Rcalvo at 17:49, 19 September 2014

2014-09-19T17:49:02Z

Rcalvo: Created page with "{{Api_Method_Spec| Description= |Parameters= {{Api_Parameter| ParamName=token |ParamType=String |ParamRequired=required |ParamDescription=A valid token for identifying the A..."

2014-09-19T17:08:41Z

Created page with "{{Api_Method_Spec| Description= |Parameters= {{Api_Parameter| ParamName=token |ParamType=String |ParamRequired=required |ParamDescription=A valid token for identifying the A..."

New page

{{Api_Method_Spec|
Description=

|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=term
|ParamType=String
|ParamRequired=required
|ParamDescription=A term that wants to request.
}}
{{Api_Parameter|
ParamName=filterBy
|ParamType=[[CatalogItemType]]
|ParamRequired=required
|ParamDescription=
}}
{{Api_Parameter|
ParamName=searchFields
|ParamType=[[SearchFieldType]]
|ParamRequired=required
|ParamDescription=
}}
{{Api_Parameter|
ParamName= sortBy
|ParamType=[[SearchFieldType]]
|ParamRequired=optional
|ParamDescription=Default value is SearchFieldType.Unknown
}}
{{Api_Parameter|
ParamName= descending
|ParamType=bool
|ParamRequired=optional
|ParamDescription=Default value is false
}}
{{Api_Parameter|
ParamName=includeAdult
|ParamType=bool
|ParamRequired=optional
|ParamDescription=Default value is false
}}
{{Api_Parameter|
ParamName= imageType
|ParamType=[[ImageType]]
|ParamRequired=optional
|ParamDescription=Default value is ImageType.Unknown
}}
{{Api_Parameter|
ParamName= width
|ParamType=int
|ParamRequired=optional
|ParamDescription=Default value is 0 (zero)
}}
{{Api_Parameter|
ParamName= height
|ParamType=int
|ParamRequired=optional
|ParamDescription=Default value is 0 (zero)
}}

|Returns=
Returns a JSON object containing an array of [[CatalogItem]] object.

'''Example:'''

{
: Content: [
:: Array of [[CatalogItem]]
: ]
}

|Exceptions=
None

|Cache=
This method is 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"

! 1.0
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}}

|SeeAlso=
}}

@@ Line 39: / Line 39: @@
 }}
 {{Api_Parameter|
-ParamName= descending
+ParamName= sortOrder
 |ParamType=bool
 |ParamRequired=optional
-|ParamDescription=Default value is false
+|ParamDescription=Default value is false (ascending)
 }}
 {{Api_Parameter|
@@ Line 68: / Line 68: @@
 |ParamDescription=Default value is 0 (zero)
 }}
+{{Api_Parameter|
 |Returns=

@@ Line 1: / Line 1: @@
 {{Api_Method_Spec|
-Description=
+Description=The method used to get a list of CatalogItem from the GVP using a term, filterBy and searchFields. The result is an array of [[CatalogItem]] that contains all movies that respect the term and field filled.
 |Parameters=