Difference between revisions of "SearchProducts"

From Gvp-public
Jump to navigation Jump to search
Line 41: Line 41:
 
|ParamType=string
 
|ParamType=string
 
|ParamRequired=required
 
|ParamRequired=required
|ParamDescription=
+
|ParamDescription=Complex filter for genreSearch i.e: {["Type": enum.GenreSearchType, "Value": "searchTerm"]}
 
}}
 
}}
 
{{Api_Parameter|
 
{{Api_Parameter|

Revision as of 07:28, 23 September 2015

Warning.png

This method has been deprecated in GVP 3.2. Please use SearchContent instead


Description

This method returns a list of products that match with the search. Currently is used SearchContent method instead.

Parameters

  • token (String, required)
A valid token for identifying the API session context. The token can be anonymous or logged.
  • channelId (int, required)
Id of the channel that wants to return the object information.
  • includeChildMovies (boolean, optional)
Requests the inclusion of the movies present in the channels below the one requested.
  • typeFilter (array, optional)
List of numbers separated by comma with the MovieType to filter the result.
  • adultFilter (enum, optional)
String separated by comma with the AdultFilterType to filter the result.
  • filter (string, required)
Complex filter for genreSearch i.e: {["Type": enum.GenreSearchType, "Value": "searchTerm"]}
  • sort (enum, optional)
Id of a MovieSortType to order the result. The default is 2 (title).
  • productTrype (int, optional)
  • offset (int, optional)
The offset number of the returned values for this request
  • limit (int, optional)
The limit number of values for this request


Returns

Returns a JSON object containing all selected products in JSON format.


Exceptions

None


Caching

This method is cached in anonymousOnly section.


Known issues

None


Version history

See also