Difference between revisions of "GetPersons"

Latest revision as of 10:40, 15 February 2016

Returns a list of Person specified in the list ID send in the request.

The result is ordered by same id sort sent in the field.

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

A valid token for identifying the API session context. The token can be anonymous or logged.

Comma-separated list of ID's that wants to be returned.

Returns a JSON object containing an array of Person.

Example:

{

"StatusCode": 0,

"Severity": 1,

"StatusMessage": "OK",

"Content":

[ Array of Person object ]

}

This method is cached.

API Version Number	Change description	Changes author
1.0	Initial method design	Harley Cabral

@@ 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.
+The result is ordered by same id sort sent in the field.
 This method can be used by anonymous login or logged user.
@@ Line 14: / Line 15: @@
 }}
 {{Api_Parameter|
-ParamName=offset
+ParamName=personIds
-|ParamType=int
+|ParamType=Array of int
-|ParamRequired=optional
+|ParamRequired=required
-|ParamDescription=The offset number of the returned values for this request
+|ParamDescription=Comma-separated list of ID's that wants to be returned.
-}}
-{{Api_Parameter|
-ParamName=limit
-|ParamType=int
-|ParamRequired=optional
-|ParamDescription=The limit number of values for this request
 }}
 |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 ]
 }