Difference between revisions of "GetPerson"

From Gvp-public
Jump to navigation Jump to search
(Created page with "{{Api_Method_Spec| Description=Returns a Person object for an specific ID. This method can be used by anonymous login or logged user. |Parameters= {{Api_Parameter| Para...")
 
 
(2 intermediate revisions by the same user not shown)
Line 13: Line 13:
 
}}
 
}}
 
{{Api_Parameter|
 
{{Api_Parameter|
ParamName=offset
+
ParamName=personId
 
|ParamType=int
 
|ParamType=int
|ParamRequired=optional
+
|ParamRequired=required
|ParamDescription=The offset number of the returned values for this request
+
|ParamDescription=ID of an person that wants to be returned on the request.
}}
 
{{Api_Parameter|
 
ParamName=limit
 
|ParamType=int
 
|ParamRequired=optional
 
|ParamDescription=The limit number of values for this request
 
 
}}
 
}}
  
Line 35: Line 29:
 
:    <span style="color: #a11">"StatusMessage"</span>: "OK",
 
:    <span style="color: #a11">"StatusMessage"</span>: "OK",
 
:    <span style="color: #a11">"Content"</span>:
 
:    <span style="color: #a11">"Content"</span>:
::       [ Object of [[Person]] ]
+
::       { Object of [[Person]] }
 
}
 
}
  

Latest revision as of 21:14, 15 July 2014

Description

Returns a Person object for an specific ID.

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.
  • personId (int, required)
ID of an person that wants to be returned on the request.


Returns

Returns a JSON object containing a Person object.

Example:

{

"Statuscode": 0,
"Severity": 1,
"StatusMessage": "OK",
"Content":
{ Object of Person }

}


Exceptions


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