Bureaucrats, editor, Administrators
282
edits
Changes
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..."
{{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|
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=personId
|ParamType=int
|ParamRequired=required
|ParamDescription=ID of an person that wants to be returned on the request.
}}
|Returns=
Returns a JSON object containing a [[Person]] object.
'''Example:'''
{
: <span style="color: #a11">"Statuscode"</span>: 0,
: <span style="color: #a11">"Severity"</span>: 1,
: <span style="color: #a11">"StatusMessage"</span>: "OK",
: <span style="color: #a11">"Content"</span>:
:: { Object of [[Person]] }
}
|Exceptions=
* [[InvalidPersonException]]
|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 [[Person]] object for an specific ID.
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=personId
|ParamType=int
|ParamRequired=required
|ParamDescription=ID of an person that wants to be returned on the request.
}}
|Returns=
Returns a JSON object containing a [[Person]] object.
'''Example:'''
{
: <span style="color: #a11">"Statuscode"</span>: 0,
: <span style="color: #a11">"Severity"</span>: 1,
: <span style="color: #a11">"StatusMessage"</span>: "OK",
: <span style="color: #a11">"Content"</span>:
:: { Object of [[Person]] }
}
|Exceptions=
* [[InvalidPersonException]]
|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=
}}
