GET api/person/{personID}
Gets person details based on the person ID
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| personID |
Person ID |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Person| Name | Description | Type | Additional information |
|---|---|---|---|
| ID |
Person ID |
integer |
None. |
| Salutation |
Title |
string |
None. |
| FirstName |
First name |
string |
None. |
| LastName |
Surname |
string |
None. |
|
Email address |
string |
None. |
|
| Phone |
Phone contact |
string |
None. |
| PersonType |
Person type |
enPersonType |
None. |
| PINOptOut |
Indicates if the person has opted out from providing a PIN |
boolean |
None. |
| Avatar |
Avatar image that is set in the website. This is a JPEG image. |
Collection of byte |
None. |
| ExternalRef |
External reference. An identifier of person record in front office systems |
string |
None. |
| TFNRecorded |
If set to true, a tax file number is recorded for the person |
boolean |
None. |
| ABN |
Australian business number |
string |
None. |
| TFNExemptionType |
Tax file number exemption type |
enTaxExemptionCode |
None. |
Response Formats
application/json, text/json
Sample:
{
"ID": 1,
"Salutation": "Mr",
"FirstName": "Xavier",
"LastName": "Test",
"Email": "XavierTest@test.com",
"Phone": "0421255326",
"PersonType": 3,
"PINOptOut": false,
"Avatar": "QXZhdGFy",
"ExternalRef": "11640",
"TFNRecorded": true,
"ABN": "2222222222",
"TFNExemptionType": 1
}
application/xml, text/xml
Sample:
<Person xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Person"> <ABN>2222222222</ABN> <Avatar>QXZhdGFy</Avatar> <Email>XavierTest@test.com</Email> <ExternalRef>11640</ExternalRef> <FirstName>Xavier</FirstName> <ID>1</ID> <LastName>Test</LastName> <PINOptOut>false</PINOptOut> <PersonType>Adviser</PersonType> <Phone>0421255326</Phone> <Salutation>Mr</Salutation> <TFNExemptionType>tfnExempt00000000000</TFNExemptionType> <TFNRecorded>true</TFNRecorded> </Person>