GET api/contacts/details?contactId={contactId}&portalId={portalId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| contactId | globally unique identifier |
Required |
|
| portalId | string |
Required |
Body Parameters
None.
Response Information
Resource Description
ContactDetails| Name | Description | Type | Additional information |
|---|---|---|---|
| WebCompanyName | string |
None. |
|
| AddressLine3 | string |
None. |
|
| AddressLine2 | string |
None. |
|
| AddressLine1 | string |
None. |
|
| AuthType | OptionSetValueModel |
None. |
|
| SignedUpAs | OptionSetValueModel |
None. |
|
| City | string |
None. |
|
| Country | string |
None. |
|
| CountryInfo | CountryInfo |
None. |
|
| string |
None. |
||
| FirstName | string |
None. |
|
| FullName | string |
None. |
|
| Gender | string |
None. |
|
| Industry | string |
None. |
|
| Id | string |
None. |
|
| JobTitle | string |
None. |
|
| Telephone1 | string |
None. |
|
| LastName | string |
None. |
|
| MemberId | string |
None. |
|
| PortalId | string |
None. |
|
| State | string |
None. |
|
| StateDetails | StateDetails |
None. |
|
| PostalCode | string |
None. |
|
| PriceLevelId | string |
None. |
|
| PriceListName | string |
None. |
|
| Embargo | boolean |
None. |
|
| EmbargoOverride | boolean |
None. |
|
| IndDesignation | string |
None. |
|
| RelatedAccounts | Collection of RelatedAccounts |
None. |
|
| ShowRecertAppButton | boolean |
None. |
|
| ParentAccount | IdNamePair |
None. |
Response Formats
application/json, text/json
Sample:
{
"WebCompanyName": "sample string 1",
"AddressLine3": "sample string 2",
"AddressLine2": "sample string 3",
"AddressLine1": "sample string 4",
"AuthType": {
"Label": "sample string 1",
"Value": 2
},
"SignedUpAs": {
"Label": "sample string 1",
"Value": 2
},
"City": "sample string 5",
"Country": "sample string 6",
"CountryInfo": {
"Id": "sample string 1",
"Code": "sample string 2",
"Name": "sample string 3"
},
"Email": "sample string 7",
"FirstName": "sample string 8",
"FullName": "sample string 9",
"Gender": "sample string 10",
"Industry": "sample string 11",
"Id": "sample string 12",
"JobTitle": "sample string 13",
"Telephone1": "sample string 14",
"LastName": "sample string 15",
"MemberId": "sample string 16",
"PortalId": "sample string 17",
"State": "sample string 18",
"StateDetails": {
"Id": "sample string 1",
"Code": "sample string 2",
"Name": "sample string 3",
"Country": {
"Id": "sample string 1",
"Code": "sample string 2",
"Name": "sample string 3"
}
},
"PostalCode": "sample string 19",
"PriceLevelId": "sample string 20",
"PriceListName": "sample string 21",
"Embargo": true,
"EmbargoOverride": true,
"IndDesignation": "sample string 24",
"RelatedAccounts": [
{
"AccountId": "6ed9e35a-f96a-4856-a4f6-e68d6392a0dd",
"AccountFullAddress": "sample string 2",
"AccountName": "sample string 3",
"AccountTypeId": "00fda12b-7c8f-40bf-99be-e91ee4b28a79",
"AccountType": "sample string 5",
"ContactTelephone": "sample string 6",
"ProviderMemberId": "sample string 7",
"ProviderPhone": "sample string 8"
},
{
"AccountId": "6ed9e35a-f96a-4856-a4f6-e68d6392a0dd",
"AccountFullAddress": "sample string 2",
"AccountName": "sample string 3",
"AccountTypeId": "00fda12b-7c8f-40bf-99be-e91ee4b28a79",
"AccountType": "sample string 5",
"ContactTelephone": "sample string 6",
"ProviderMemberId": "sample string 7",
"ProviderPhone": "sample string 8"
}
],
"ShowRecertAppButton": true,
"ParentAccount": {
"Id": "989baead-ed96-4959-b026-49e53d893256",
"Name": "sample string 2"
}
}
application/xml, text/xml
Sample:
<ContactDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models">
<AddressLine1>sample string 4</AddressLine1>
<AddressLine2>sample string 3</AddressLine2>
<AddressLine3>sample string 2</AddressLine3>
<AuthType xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d2p1:Label>sample string 1</d2p1:Label>
<d2p1:Value>2</d2p1:Value>
</AuthType>
<City>sample string 5</City>
<Country>sample string 6</Country>
<CountryInfo>
<Code>sample string 2</Code>
<Id>sample string 1</Id>
<Name>sample string 3</Name>
</CountryInfo>
<Email>sample string 7</Email>
<Embargo>true</Embargo>
<EmbargoOverride>true</EmbargoOverride>
<FirstName>sample string 8</FirstName>
<FullName>sample string 9</FullName>
<Gender>sample string 10</Gender>
<Id>sample string 12</Id>
<IndDesignation>sample string 24</IndDesignation>
<Industry>sample string 11</Industry>
<JobTitle>sample string 13</JobTitle>
<LastName>sample string 15</LastName>
<MemberId>sample string 16</MemberId>
<ParentAccount xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d2p1:Id>989baead-ed96-4959-b026-49e53d893256</d2p1:Id>
<d2p1:Name>sample string 2</d2p1:Name>
</ParentAccount>
<PortalId>sample string 17</PortalId>
<PostalCode>sample string 19</PostalCode>
<PriceLevelId>sample string 20</PriceLevelId>
<PriceListName>sample string 21</PriceListName>
<RelatedAccounts>
<RelatedAccounts>
<AccountFullAddress>sample string 2</AccountFullAddress>
<AccountId>6ed9e35a-f96a-4856-a4f6-e68d6392a0dd</AccountId>
<AccountName>sample string 3</AccountName>
<AccountType>sample string 5</AccountType>
<AccountTypeId>00fda12b-7c8f-40bf-99be-e91ee4b28a79</AccountTypeId>
<ContactTelephone>sample string 6</ContactTelephone>
<ProviderMemberId>sample string 7</ProviderMemberId>
<ProviderPhone>sample string 8</ProviderPhone>
</RelatedAccounts>
<RelatedAccounts>
<AccountFullAddress>sample string 2</AccountFullAddress>
<AccountId>6ed9e35a-f96a-4856-a4f6-e68d6392a0dd</AccountId>
<AccountName>sample string 3</AccountName>
<AccountType>sample string 5</AccountType>
<AccountTypeId>00fda12b-7c8f-40bf-99be-e91ee4b28a79</AccountTypeId>
<ContactTelephone>sample string 6</ContactTelephone>
<ProviderMemberId>sample string 7</ProviderMemberId>
<ProviderPhone>sample string 8</ProviderPhone>
</RelatedAccounts>
</RelatedAccounts>
<ShowRecertAppButton>true</ShowRecertAppButton>
<SignedUpAs xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d2p1:Label>sample string 1</d2p1:Label>
<d2p1:Value>2</d2p1:Value>
</SignedUpAs>
<State>sample string 18</State>
<StateDetails>
<Code>sample string 2</Code>
<Country>
<Code>sample string 2</Code>
<Id>sample string 1</Id>
<Name>sample string 3</Name>
</Country>
<Id>sample string 1</Id>
<Name>sample string 3</Name>
</StateDetails>
<Telephone1>sample string 14</Telephone1>
<WebCompanyName>sample string 1</WebCompanyName>
</ContactDetails>