Difference between revisions of "GetAllPersons"

Latest revision as of 13:59, 16 July 2014

Returns a list of Person registered on the instance. The result is default ordered by the title 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.

The offset number of the returned values for this request

The limit number of values for this request

Returns a JSON object containing an array of Person.

Example:

{

"Offset": 0,

"Limit": 100,

"Count": 6,

"List":

[ 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]] registered on the instance.
-The result is ordered by same id sort sent in the field.
+The result is default ordered by the title field.
 This method can be used by anonymous login or logged user.
@@ Line 14: / Line 14: @@
 }}
 {{Api_Parameter|
-ParamName=personIds
+ParamName=offset
 |ParamType=int
-|ParamRequired=required
+|ParamRequired=optional
-|ParamDescription=List of ID's that wants to be returned.
+|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
 }}
@@ Line 26: / Line 32: @@
 {
-:     <span style="color: #a11">"StatusCode"</span>: 0,
+:     <span style="color: #a11">"Offset"</span>: 0,
-:     <span style="color: #a11">"Severity"</span>: 1,
+:     <span style="color: #a11">"Limit"</span>: 100,
-:     <span style="color: #a11">"StatusMessage"</span>: "OK",
+:     <span style="color: #a11">"Count"</span>: 6,
-:     <span style="color: #a11">"Content"</span>:
+:     <span style="color: #a11">"List"</span>:
 ::        [ Array of [[Person]] object ]
 }