Difference between revisions of "GetPerson"

From Gvp-public
Jump to navigation Jump to search
Line 12: Line 12:
 
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
 
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
 
}}
 
}}
{{Api_Parameter|
+
ParamName=personId
ParamName=offset
 
 
|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
 
 
}}
 
}}
  

Revision as of 20:08, 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.

ParamName=personId


Returns

{{{Returns}}}


Exceptions

{{{Exceptions}}}


Caching

{{{Cache}}}


Known issues

{{{KnownIssues}}}


Version history

{{{VersionHistory}}}


See also

{{{SeeAlso}}}

|Returns= Returns a JSON object containing a Person object.

Example:

{

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

}


|Exceptions=

|Cache= This method is cached.

|KnownIssues=

  • None

|VersionHistory=

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

|SeeAlso=

}}