GET api/Contact/{portalId}/{applicationAccess}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| portalId | string |
Required |
|
| applicationAccess | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
ClientPortalUser| Name | Description | Type | Additional information |
|---|---|---|---|
| MemberId | string |
None. |
|
| PortalId | string |
None. |
|
| ContactId | globally unique identifier |
None. |
|
| FirstName | string |
None. |
|
| MiddleName | string |
None. |
|
| LastName | string |
None. |
|
| string |
None. |
||
| ContactModifiedOn | string |
None. |
|
| DefaultPriceList | string |
None. |
|
| Suffix | string |
None. |
|
| ParentCustomer | string |
None. |
|
| ParentCustomerId | string |
None. |
|
| JobTitle | string |
None. |
|
| Address1Line1 | string |
None. |
|
| Address1Line2 | string |
None. |
|
| Address1Line3 | string |
None. |
|
| Address1City | string |
None. |
|
| Address1State | string |
None. |
|
| Address1Zip | string |
None. |
|
| Nickname | string |
None. |
|
| Phone | string |
None. |
|
| Website | string |
None. |
|
| ExcludeFromHLDirectory | boolean |
None. |
|
| ExcludeFromHL | boolean |
None. |
|
| ContactRoles | Collection of ClientContactRole |
None. |
|
| IsActive | boolean |
None. |
|
| Certifications | string |
None. |
|
| AreaOfInterest | string |
None. |
|
| EmploymentStatus | string |
None. |
|
| FocusOfPractice | string |
None. |
|
| JobFunction | string |
None. |
|
| JobRole | string |
None. |
|
| MedicalLicensure | string |
None. |
|
| MilitaryService | string |
None. |
|
| ActiveMilitaryService | boolean |
None. |
|
| OriginalJoinDate | string |
None. |
|
| PracticeSetting | string |
None. |
|
| PracticeSettingOther | string |
None. |
|
| PracticeType | string |
None. |
|
| UsGovernmentEmployee | boolean |
None. |
|
| Education | string |
None. |
|
| Birthday | string |
None. |
|
| Age | integer |
None. |
|
| MemberSince | string |
None. |
|
| MemberExpiresOn | string |
None. |
|
| Designation | string |
None. |
|
| Prefix | string |
None. |
|
| Gender | string |
None. |
|
| Ethnicity | string |
None. |
|
| CompanyName | string |
None. |
|
| PrimaryMembership | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"MemberId": "sample string 1",
"PortalId": "sample string 2",
"ContactId": "17691f48-fddd-4d68-b632-cc67d4c0ca05",
"FirstName": "sample string 4",
"MiddleName": "sample string 5",
"LastName": "sample string 6",
"Email": "sample string 7",
"ContactModifiedOn": "sample string 8",
"DefaultPriceList": "sample string 9",
"Suffix": "sample string 10",
"ParentCustomer": "sample string 11",
"ParentCustomerId": "sample string 12",
"JobTitle": "sample string 13",
"Address1Line1": "sample string 14",
"Address1Line2": "sample string 15",
"Address1Line3": "sample string 16",
"Address1City": "sample string 17",
"Address1State": "sample string 18",
"Address1Zip": "sample string 19",
"Nickname": "sample string 20",
"Phone": "sample string 21",
"Website": "sample string 22",
"ExcludeFromHLDirectory": true,
"ExcludeFromHL": true,
"ContactRoles": [
{
"Id": "41c39ed5-72b1-4f58-b535-f9a211ccca4c",
"Status": 2,
"AccountId": "ae086b23-e276-4058-9c7b-b5c6df9f9de3",
"RoleName": "sample string 3",
"RoleCode": "sample string 4",
"RoleType": "sample string 5",
"ContactRoleModifiedOn": "sample string 6",
"ApplicationAccess": "sample string 7"
},
{
"Id": "41c39ed5-72b1-4f58-b535-f9a211ccca4c",
"Status": 2,
"AccountId": "ae086b23-e276-4058-9c7b-b5c6df9f9de3",
"RoleName": "sample string 3",
"RoleCode": "sample string 4",
"RoleType": "sample string 5",
"ContactRoleModifiedOn": "sample string 6",
"ApplicationAccess": "sample string 7"
}
],
"IsActive": true,
"Certifications": "sample string 26",
"AreaOfInterest": "sample string 27",
"EmploymentStatus": "sample string 28",
"FocusOfPractice": "sample string 29",
"JobFunction": "sample string 30",
"JobRole": "sample string 31",
"MedicalLicensure": "sample string 32",
"MilitaryService": "sample string 33",
"ActiveMilitaryService": true,
"OriginalJoinDate": "sample string 35",
"PracticeSetting": "sample string 36",
"PracticeSettingOther": "sample string 37",
"PracticeType": "sample string 38",
"UsGovernmentEmployee": true,
"Education": "sample string 40",
"Birthday": "sample string 41",
"Age": 1,
"MemberSince": "sample string 42",
"MemberExpiresOn": "sample string 43",
"Designation": "sample string 44",
"Prefix": "sample string 45",
"Gender": "sample string 46",
"Ethnicity": "sample string 47",
"CompanyName": "sample string 48",
"PrimaryMembership": "sample string 49"
}
application/xml, text/xml
Sample:
<ClientPortalUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AltaiStandard.Integration.API.Models">
<ActiveMilitaryService>true</ActiveMilitaryService>
<Address1City>sample string 17</Address1City>
<Address1Line1>sample string 14</Address1Line1>
<Address1Line2>sample string 15</Address1Line2>
<Address1Line3>sample string 16</Address1Line3>
<Address1State>sample string 18</Address1State>
<Address1Zip>sample string 19</Address1Zip>
<Age>1</Age>
<AreaOfInterest>sample string 27</AreaOfInterest>
<Birthday>sample string 41</Birthday>
<Certifications>sample string 26</Certifications>
<CompanyName>sample string 48</CompanyName>
<ContactId>17691f48-fddd-4d68-b632-cc67d4c0ca05</ContactId>
<ContactModifiedOn>sample string 8</ContactModifiedOn>
<ContactRoles>
<ClientContactRole>
<AccountId>ae086b23-e276-4058-9c7b-b5c6df9f9de3</AccountId>
<ApplicationAccess>sample string 7</ApplicationAccess>
<ContactRoleModifiedOn>sample string 6</ContactRoleModifiedOn>
<Id>41c39ed5-72b1-4f58-b535-f9a211ccca4c</Id>
<RoleCode>sample string 4</RoleCode>
<RoleName>sample string 3</RoleName>
<RoleType>sample string 5</RoleType>
<Status>2</Status>
</ClientContactRole>
<ClientContactRole>
<AccountId>ae086b23-e276-4058-9c7b-b5c6df9f9de3</AccountId>
<ApplicationAccess>sample string 7</ApplicationAccess>
<ContactRoleModifiedOn>sample string 6</ContactRoleModifiedOn>
<Id>41c39ed5-72b1-4f58-b535-f9a211ccca4c</Id>
<RoleCode>sample string 4</RoleCode>
<RoleName>sample string 3</RoleName>
<RoleType>sample string 5</RoleType>
<Status>2</Status>
</ClientContactRole>
</ContactRoles>
<DefaultPriceList>sample string 9</DefaultPriceList>
<Designation>sample string 44</Designation>
<Education>sample string 40</Education>
<Email>sample string 7</Email>
<EmploymentStatus>sample string 28</EmploymentStatus>
<Ethnicity>sample string 47</Ethnicity>
<ExcludeFromHL>true</ExcludeFromHL>
<ExcludeFromHLDirectory>true</ExcludeFromHLDirectory>
<FirstName>sample string 4</FirstName>
<FocusOfPractice>sample string 29</FocusOfPractice>
<Gender>sample string 46</Gender>
<IsActive>true</IsActive>
<JobFunction>sample string 30</JobFunction>
<JobRole>sample string 31</JobRole>
<JobTitle>sample string 13</JobTitle>
<LastName>sample string 6</LastName>
<MedicalLicensure>sample string 32</MedicalLicensure>
<MemberExpiresOn>sample string 43</MemberExpiresOn>
<MemberId>sample string 1</MemberId>
<MemberSince>sample string 42</MemberSince>
<MiddleName>sample string 5</MiddleName>
<MilitaryService>sample string 33</MilitaryService>
<Nickname>sample string 20</Nickname>
<OriginalJoinDate>sample string 35</OriginalJoinDate>
<ParentCustomer>sample string 11</ParentCustomer>
<ParentCustomerId>sample string 12</ParentCustomerId>
<Phone>sample string 21</Phone>
<PortalId>sample string 2</PortalId>
<PracticeSetting>sample string 36</PracticeSetting>
<PracticeSettingOther>sample string 37</PracticeSettingOther>
<PracticeType>sample string 38</PracticeType>
<Prefix>sample string 45</Prefix>
<PrimaryMembership>sample string 49</PrimaryMembership>
<Suffix>sample string 10</Suffix>
<UsGovernmentEmployee>true</UsGovernmentEmployee>
<Website>sample string 22</Website>
</ClientPortalUser>