GET api/contacts/relatedAccounts?contactId={contactId}&accountType={accountType}
Get related accounts for a given contact
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
contactId |
Guid 00000000-0000-0000-0000-000000000000 |
globally unique identifier |
Required |
accountType |
Approved Provider |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
ContactRelatedAccountsName | Description | Type | Additional information |
---|---|---|---|
AddressLine3 | string |
None. |
|
AddressLine2 | string |
None. |
|
AddressLine1 | string |
None. |
|
City | string |
None. |
|
Country | string |
None. |
|
FullName | string |
None. |
|
Id | string |
None. |
|
Telephone1 | string |
None. |
|
State | string |
None. |
|
PostalCode | string |
None. |
|
RelatedAccounts | Collection of Accounts |
None. |
Response Formats
application/json, text/json
Sample:
{ "AddressLine3": "sample string 1", "AddressLine2": "sample string 2", "AddressLine1": "sample string 3", "City": "sample string 4", "Country": "sample string 5", "FullName": "sample string 6", "Id": "sample string 7", "Telephone1": "sample string 8", "State": "sample string 9", "PostalCode": "sample string 10", "RelatedAccounts": [ { "AccountId": "87137d85-e00b-4362-bac6-fdc07a5061cb", "AccountFullAddress": "sample string 2", "AccountName": "sample string 3", "AccountTypeId": "88208dac-9c0a-407f-916f-6a92ef538723", "AccountType": "sample string 5", "ProviderMemberId": "sample string 6", "ProviderPhone": "sample string 7" }, { "AccountId": "87137d85-e00b-4362-bac6-fdc07a5061cb", "AccountFullAddress": "sample string 2", "AccountName": "sample string 3", "AccountTypeId": "88208dac-9c0a-407f-916f-6a92ef538723", "AccountType": "sample string 5", "ProviderMemberId": "sample string 6", "ProviderPhone": "sample string 7" } ] }
application/xml, text/xml
Sample:
<ContactRelatedAccounts xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models"> <AddressLine1>sample string 3</AddressLine1> <AddressLine2>sample string 2</AddressLine2> <AddressLine3>sample string 1</AddressLine3> <City>sample string 4</City> <Country>sample string 5</Country> <FullName>sample string 6</FullName> <Id>sample string 7</Id> <PostalCode>sample string 10</PostalCode> <RelatedAccounts> <Accounts> <AccountFullAddress>sample string 2</AccountFullAddress> <AccountId>87137d85-e00b-4362-bac6-fdc07a5061cb</AccountId> <AccountName>sample string 3</AccountName> <AccountType>sample string 5</AccountType> <AccountTypeId>88208dac-9c0a-407f-916f-6a92ef538723</AccountTypeId> <ProviderMemberId>sample string 6</ProviderMemberId> <ProviderPhone>sample string 7</ProviderPhone> </Accounts> <Accounts> <AccountFullAddress>sample string 2</AccountFullAddress> <AccountId>87137d85-e00b-4362-bac6-fdc07a5061cb</AccountId> <AccountName>sample string 3</AccountName> <AccountType>sample string 5</AccountType> <AccountTypeId>88208dac-9c0a-407f-916f-6a92ef538723</AccountTypeId> <ProviderMemberId>sample string 6</ProviderMemberId> <ProviderPhone>sample string 7</ProviderPhone> </Accounts> </RelatedAccounts> <State>sample string 9</State> <Telephone1>sample string 8</Telephone1> </ContactRelatedAccounts>