GET api/programs/contact/{contactId}/eligibility
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| contactId | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of ContactEligibilityStatus| Name | Description | Type | Additional information |
|---|---|---|---|
| ProgramId | globally unique identifier |
None. |
|
| ProgramStatus | string |
None. |
|
| StatusMessage | string |
None. |
|
| ActiveApplicationId | globally unique identifier |
None. |
|
| ApplicationStatus | IdNamePair |
None. |
|
| ApplicationStatusDetails | string |
None. |
|
| StatusHeading | string |
None. |
|
| PriorAccessToExamContent | boolean |
None. |
|
| ExamEligibilityDate | date |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"ProgramId": "6aeec464-69d4-4334-8e2c-587aaaf02bab",
"ProgramStatus": "sample string 2",
"StatusMessage": "sample string 3",
"ActiveApplicationId": "8e360a8e-bdb5-41b1-a48d-f2e39e313af1",
"ApplicationStatus": {
"Id": "b1d4a021-e873-4989-adcb-de5b11da8a46",
"Name": "sample string 2"
},
"ApplicationStatusDetails": "sample string 5",
"StatusHeading": "sample string 6",
"PriorAccessToExamContent": true,
"ExamEligibilityDate": "2025-11-07T05:21:29.3616869+00:00"
},
{
"ProgramId": "6aeec464-69d4-4334-8e2c-587aaaf02bab",
"ProgramStatus": "sample string 2",
"StatusMessage": "sample string 3",
"ActiveApplicationId": "8e360a8e-bdb5-41b1-a48d-f2e39e313af1",
"ApplicationStatus": {
"Id": "b1d4a021-e873-4989-adcb-de5b11da8a46",
"Name": "sample string 2"
},
"ApplicationStatusDetails": "sample string 5",
"StatusHeading": "sample string 6",
"PriorAccessToExamContent": true,
"ExamEligibilityDate": "2025-11-07T05:21:29.3616869+00:00"
}
]
application/xml, text/xml
Sample:
<ArrayOfContactEligibilityStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models">
<ContactEligibilityStatus>
<ActiveApplicationId>8e360a8e-bdb5-41b1-a48d-f2e39e313af1</ActiveApplicationId>
<ApplicationStatus xmlns:d3p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d3p1:Id>b1d4a021-e873-4989-adcb-de5b11da8a46</d3p1:Id>
<d3p1:Name>sample string 2</d3p1:Name>
</ApplicationStatus>
<ApplicationStatusDetails>sample string 5</ApplicationStatusDetails>
<ExamEligibilityDate>2025-11-07T05:21:29.3616869+00:00</ExamEligibilityDate>
<PriorAccessToExamContent>true</PriorAccessToExamContent>
<ProgramId>6aeec464-69d4-4334-8e2c-587aaaf02bab</ProgramId>
<ProgramStatus>sample string 2</ProgramStatus>
<StatusHeading>sample string 6</StatusHeading>
<StatusMessage>sample string 3</StatusMessage>
</ContactEligibilityStatus>
<ContactEligibilityStatus>
<ActiveApplicationId>8e360a8e-bdb5-41b1-a48d-f2e39e313af1</ActiveApplicationId>
<ApplicationStatus xmlns:d3p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d3p1:Id>b1d4a021-e873-4989-adcb-de5b11da8a46</d3p1:Id>
<d3p1:Name>sample string 2</d3p1:Name>
</ApplicationStatus>
<ApplicationStatusDetails>sample string 5</ApplicationStatusDetails>
<ExamEligibilityDate>2025-11-07T05:21:29.3616869+00:00</ExamEligibilityDate>
<PriorAccessToExamContent>true</PriorAccessToExamContent>
<ProgramId>6aeec464-69d4-4334-8e2c-587aaaf02bab</ProgramId>
<ProgramStatus>sample string 2</ProgramStatus>
<StatusHeading>sample string 6</StatusHeading>
<StatusMessage>sample string 3</StatusMessage>
</ContactEligibilityStatus>
</ArrayOfContactEligibilityStatus>