GET api/bfg/v1/persons/{personId}/details
Person contact and address details (<c>SH_GetPersonDetails</c>).
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| personId | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
PersonDetailsResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| ResidentialAddressId | integer |
None. |
|
| ResidentialAddress1 | string |
None. |
|
| ResidentialAddress2 | string |
None. |
|
| ResidentialSuburb | string |
None. |
|
| ResidentialState | string |
None. |
|
| ResidentialPostcode | string |
None. |
|
| ResidentialCountry | string |
None. |
|
| PostalAddressId | integer |
None. |
|
| PostalAddress1 | string |
None. |
|
| PostalAddress2 | string |
None. |
|
| PostalSuburb | string |
None. |
|
| PostalState | string |
None. |
|
| PostalPostcode | string |
None. |
|
| PostalCountry | string |
None. |
|
| EmailAddress | string |
None. |
|
| PhoneHome | string |
None. |
|
| PhoneWork | string |
None. |
|
| PhoneMobile | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"ResidentialAddressId": 1,
"ResidentialAddress1": "sample string 1",
"ResidentialAddress2": "sample string 2",
"ResidentialSuburb": "sample string 3",
"ResidentialState": "sample string 4",
"ResidentialPostcode": "sample string 5",
"ResidentialCountry": "sample string 6",
"PostalAddressId": 1,
"PostalAddress1": "sample string 7",
"PostalAddress2": "sample string 8",
"PostalSuburb": "sample string 9",
"PostalState": "sample string 10",
"PostalPostcode": "sample string 11",
"PostalCountry": "sample string 12",
"EmailAddress": "sample string 13",
"PhoneHome": "sample string 14",
"PhoneWork": "sample string 15",
"PhoneMobile": "sample string 16"
}
application/xml, text/xml
Sample:
<PersonDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.Person"> <EmailAddress>sample string 13</EmailAddress> <PhoneHome>sample string 14</PhoneHome> <PhoneMobile>sample string 16</PhoneMobile> <PhoneWork>sample string 15</PhoneWork> <PostalAddress1>sample string 7</PostalAddress1> <PostalAddress2>sample string 8</PostalAddress2> <PostalAddressId>1</PostalAddressId> <PostalCountry>sample string 12</PostalCountry> <PostalPostcode>sample string 11</PostalPostcode> <PostalState>sample string 10</PostalState> <PostalSuburb>sample string 9</PostalSuburb> <ResidentialAddress1>sample string 1</ResidentialAddress1> <ResidentialAddress2>sample string 2</ResidentialAddress2> <ResidentialAddressId>1</ResidentialAddressId> <ResidentialCountry>sample string 6</ResidentialCountry> <ResidentialPostcode>sample string 5</ResidentialPostcode> <ResidentialState>sample string 4</ResidentialState> <ResidentialSuburb>sample string 3</ResidentialSuburb> </PersonDetailsResponse>