editor
725
edits
Changes
Jump to navigation
Jump to search
Created page with "{{Api_Method_Spec| Description=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..."
{{Api_Method_Spec|
Description=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.
|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:'''
{
: <span style="color: #a11">"Offset"</span>: 0,
: <span style="color: #a11">"Limit"</span>: 100,
: <span style="color: #a11">"Count"</span>: 6,
: <span style="color: #a11">"List"</span>:
:: [ 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=
}}
Description=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.
|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:'''
{
: <span style="color: #a11">"Offset"</span>: 0,
: <span style="color: #a11">"Limit"</span>: 100,
: <span style="color: #a11">"Count"</span>: 6,
: <span style="color: #a11">"List"</span>:
:: [ 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=
}}
