SearchContent

From Gvp-public
Revision as of 17:08, 19 September 2014 by Rcalvo (talk | contribs) (Created page with "{{Api_Method_Spec| Description= |Parameters= {{Api_Parameter| ParamName=token |ParamType=String |ParamRequired=required |ParamDescription=A valid token for identifying the A...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Description

Parameters

  • token (String, required)
A valid token for identifying the API session context. The token can be anonymous or logged.
  • term (String, required)
A term that wants to request.
Default value is SearchFieldType.Unknown
  • descending (bool, optional)
Default value is false
  • includeAdult (bool, optional)
Default value is false
Default value is ImageType.Unknown
  • width (int, optional)
Default value is 0 (zero)
  • height (int, optional)
Default value is 0 (zero)


Returns

Returns a JSON object containing an array of CatalogItem object.

Example:

{

Content: [
Array of CatalogItem
]

}


Exceptions

None


Caching

This method is cached.


Known issues

None


Version history

API Version Number Change description Changes author
1.0 Initial method design Harley Cabral


See also