Difference between revisions of "SearchGenres"

From Gvp-public
Jump to navigation Jump to search
(Created page with "{{Api_Method_Spec| Description= |Parameters= {{Api_Parameter| ParamName=token |ParamType=String |ParamRequired=required |ParamDescription=A valid token for identifying the AP...")
 
Line 1: Line 1:
 
{{Api_Method_Spec|
 
{{Api_Method_Spec|
Description=
+
Description=This method is used to find movies or series genres in UNIAPI. Currently SearchContent method is used instead because it is deprecated.
  
 
|Parameters=
 
|Parameters=
Line 13: Line 13:
 
|ParamType=object
 
|ParamType=object
 
|ParamRequired=required
 
|ParamRequired=required
|ParamDescription=
+
|ParamDescription=Complex filter for genreSearch i.e: {["Type": enum.GenreSearchType, "Value": "searchTerm"]}
 
}}
 
}}
 
{{Api_Parameter|
 
{{Api_Parameter|
Line 29: Line 29:
  
 
|Returns=
 
|Returns=
Returns a JSON object with the list of objects.
+
Returns a JSON object with the list of genre objects.
  
 
|Exceptions=
 
|Exceptions=

Revision as of 12:43, 22 September 2015

Description

This method is used to find movies or series genres in UNIAPI. Currently SearchContent method is used instead because it is deprecated.

Parameters

  • token (String, required)
A valid token for identifying the API session context and logged user.
  • filter (object, required)
Complex filter for genreSearch i.e: {["Type": enum.GenreSearchType, "Value": "searchTerm"]}
  • offset (int, optional)
Index of the initial result of the list, begins with 0
  • limit (int, optional)
Quantity of results showed, with the maximum of 100.


Returns

Returns a JSON object with the list of genre objects.


Exceptions

TO BE COMPLETED


Caching

This method is not cached.


Known issues

None


Version history

TO BE COMPLETED


See also