Difference between revisions of "SearchProducts"

From Gvp-public
Jump to navigation Jump to search
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{Deprecated|Message=This method has been deprecated in GVP 3.2. Please use [[SearchContent]] instead}}
 
{{Deprecated|Message=This method has been deprecated in GVP 3.2. Please use [[SearchContent]] instead}}
 +
 +
{{Api_Method_Spec|
 +
Description=This method returns a list of products that match with the search. Currently is used SearchContent method instead.
 +
 +
 +
|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=Id of the channel that wants to return the object information.
 +
}}
 +
{{Api_Parameter|
 +
ParamName=includeChildMovies
 +
|ParamType=boolean
 +
|ParamRequired=optional
 +
|ParamDescription=Requests the inclusion of the movies present in the channels below the one requested.
 +
}}
 +
{{Api_Parameter|
 +
ParamName=typeFilter
 +
|ParamType=array
 +
|ParamRequired=optional
 +
|ParamDescription=List of numbers separated by comma with the [[MovieType]] to filter the result.
 +
}}
 +
{{Api_Parameter|
 +
ParamName=adultFilter
 +
|ParamType=enum
 +
|ParamRequired=optional
 +
|ParamDescription=String separated by comma with the [[AdultFilterType]] to filter the result.
 +
}}
 +
{{Api_Parameter|
 +
ParamName=filter
 +
|ParamType=string
 +
|ParamRequired=required
 +
|ParamDescription=Complex filter for genreSearch i.e: {["Type": enum.GenreSearchType, "Value": "searchTerm"]}
 +
}}
 +
{{Api_Parameter|
 +
ParamName=sort
 +
|ParamType=enum
 +
|ParamRequired=optional
 +
|ParamDescription=Id of a [[MovieSortType]] to order the result. The default is 2 (title).
 +
}}
 +
{{Api_Parameter|
 +
ParamName=productTrype
 +
|ParamType=int
 +
|ParamRequired=optional
 +
|ParamDescription=
 +
}}
 +
{{Api_Parameter|
 +
ParamName=offset
 +
|ParamType=int
 +
|ParamRequired=optional
 +
|ParamDescription=The offset number of the returned values for this request
 +
}}
 +
{{Api_Parameter|
 +
ParamName=limit
 +
|ParamType=int
 +
|ParamRequired=optional
 +
|ParamDescription=The limit number of values for this request
 +
}}
 +
 +
|Returns=
 +
Returns a JSON object containing all selected products in JSON format.
 +
 +
|Exceptions=
 +
None
 +
 +
|Cache=
 +
This method is cached in anonymousOnly section.
 +
 +
|KnownIssues=
 +
None
 +
 +
|VersionHistory=
 +
<span style="color: #a11;">TO BE COMPLETED</span>
 +
 +
|SeeAlso=
 +
* [[SearchContent]] method
 +
}}

Latest revision as of 07:55, 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

TO BE COMPLETED


See also

Retrieved from "https://wikis.tid.es/gvp-public/index.php?title=SearchProducts&oldid=1545"