GetPersons

From Gvp-public
Revision as of 13:39, 16 July 2014 by Rcalvo (talk | contribs) (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...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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

  • token (String, required)
A valid token for identifying the API session context. The token can be anonymous or logged.
  • 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.

Example:

{

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

}


Exceptions

  • None


Caching

This method is cached.


Known issues

  • None


Version history

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


See also