Difference between revisions of "SearchPersons"

From Gvp-public
Jump to navigation Jump to search
(Created page with "{{Api_Method_Spec| Description=Returns a list of Person in the GVP group. This method can be used by anonymous login or logged user. |Parameters= {{Api_Parameter| ParamN...")
 
 
(3 intermediate revisions by one other user not shown)
Line 1: Line 1:
 +
{{Deprecated|Message=This method has been deprecated in GVP 3.2.}}
 +
 +
 
{{Api_Method_Spec|
 
{{Api_Method_Spec|
Description=Returns a list of [[Person]] in the GVP group.
+
Description=Returns a list of [[Person]] in the GVP group, it can be used by anonymous login or logged user. This method is deprecated, [[SearchContent]] is used instead.
This method can be used by anonymous login or logged user.
+
 
  
 
|Parameters=
 
|Parameters=
Line 45: Line 48:
  
 
|VersionHistory=
 
|VersionHistory=
 
+
<span style="color: #a11;">TO BE COMPLETED</span>
  
 
|SeeAlso=
 
|SeeAlso=
 
* [[GetPersons]] method
 
* [[GetPersons]] method
 +
* [[SearchContent]] method
 
}}
 
}}

Latest revision as of 09:19, 24 February 2016

Warning.png

This method has been deprecated in GVP 3.2.


Description

Returns a list of Person in the GVP group, it can be used by anonymous login or logged user. This method is deprecated, SearchContent is used instead.

Parameters

  • token (String, required)
A valid token for identifying the API session context. The token can be anonymous or logged.
  • filter (string, required)
Complex filter for genreSearch i.e: {["Type": enum.GenreSearchType, "Value": "searchTerm"]}
  • 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 an array of Person.


Exceptions

  • None


Caching

This method is not cached.


Known issues

  • None


Version history

TO BE COMPLETED


See also