Difference between revisions of "GetPersons"

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

Latest revision as of 10:40, 15 February 2016

Description

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.

Parameters

  • token (String, required)
A valid token for identifying the API session context. The token can be anonymous or logged.
  • personIds (Array of int, required)
Comma-separated list of ID's that wants to be returned.


Returns

Returns a JSON object containing an array of Person.

Example:

{

"StatusCode": 0,
"Severity": 1,
"StatusMessage": "OK",
"Content":
[ 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