Difference between revisions of "SearchProducts"
Jump to navigation
Jump to search
| (3 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
| − | Description= | + | Description=This method returns a list of products that match with the search. Currently is used SearchContent method instead. |
| Line 29: | Line 29: | ||
|ParamType=array | |ParamType=array | ||
|ParamRequired=optional | |ParamRequired=optional | ||
| − | |ParamDescription= | + | |ParamDescription=List of numbers separated by comma with the [[MovieType]] to filter the result. |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| Line 35: | Line 35: | ||
|ParamType=enum | |ParamType=enum | ||
|ParamRequired=optional | |ParamRequired=optional | ||
| − | |ParamDescription= | + | |ParamDescription=String separated by comma with the [[AdultFilterType]] to filter the result. |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| 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| | ||
| Line 47: | Line 47: | ||
|ParamType=enum | |ParamType=enum | ||
|ParamRequired=optional | |ParamRequired=optional | ||
| − | |ParamDescription= | + | |ParamDescription=Id of a [[MovieSortType]] to order the result. The default is 2 (title). |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| Line 81: | Line 81: | ||
|VersionHistory= | |VersionHistory= | ||
| − | + | <span style="color: #a11;">TO BE COMPLETED</span> | |
|SeeAlso= | |SeeAlso= | ||
| + | * [[SearchContent]] method | ||
}} | }} | ||
Latest revision as of 07:55, 23 September 2015
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
TO BE COMPLETED
See also
- SearchContent method
