GetPersons - Revision history

Pcl245 at 10:40, 15 February 2016

2016-02-15T10:40:43Z

Rcalvo at 13:59, 16 July 2014

2014-07-16T13:59:02Z

Rcalvo: Created page with "{{Api_Method_Spec| Description=Returns a list of Person specified in the list ID send in the request. The result is default ordered by the title field. This method can be..."

2014-07-16T13:39:01Z

Created page with "{{Api_Method_Spec| Description=Returns a list of Person specified in the list ID send in the request. The result is default ordered by the title field. This method can be..."

New page

{{Api_Method_Spec|
Description=Returns a list of [[Person]] specified in the list ID send in the request.
The result is default ordered by the title field.

This method can be used by anonymous login or logged user.

|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=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 an array of [[Person]].

'''Example:'''

{
: "Offset": 0,
: "Limit": 100,
: "Count": 6,
: "List":
:: [ Array of [[Person]] object ]
}

|Exceptions=
* None

|Cache=
This method is cached.

|KnownIssues=
* None

|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 1.0
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}}

|SeeAlso=

}}

@@ Line 16: / Line 16: @@
 {{Api_Parameter|
 ParamName=personIds
-|ParamType=int
+|ParamType=Array of int
 |ParamRequired=required
-|ParamDescription=List of ID's that wants to be returned.
+|ParamDescription=Comma-separated list of ID's that wants to be returned.
 }}

@@ Line 1: / Line 1: @@
 {{Api_Method_Spec|
 Description=Returns a list of [[Person]] specified in the list ID send in the request.
-The result is default ordered by the title field.
 This method can be used by anonymous login or logged user.
@@ Line 14: / Line 15: @@
 }}
 {{Api_Parameter|
-ParamName=offset
+ParamName=personIds
 |ParamType=int
-|ParamRequired=optional
+|ParamRequired=required
-|ParamDescription=The offset number of the returned values for this request
+|ParamDescription=List of ID's that wants to be returned.
 }}
 |Returns=
@@ Line 32: / Line 28: @@
+{
-:     <span style="color: #a11">"Offset"</span>: 0,
+:     <span style="color: #a11">"StatusCode"</span>: 0,
-:     <span style="color: #a11">"Limit"</span>: 100,
+:     <span style="color: #a11">"Severity"</span>: 1,
-:     <span style="color: #a11">"Count"</span>: 6,
+:     <span style="color: #a11">"StatusMessage"</span>: "OK",
-:     <span style="color: #a11">"List"</span>:
+:     <span style="color: #a11">"Content"</span>:
 ::        [ Array of [[Person]] object ]
+}