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": "c4542482-7fa1-4999-8227-2cf5b6811fc2",
"ProgramStatus": "sample string 2",
"StatusMessage": "sample string 3",
"ActiveApplicationId": "af645d95-522c-4f8e-9e68-d6f019096463",
"ApplicationStatus": {
"Id": "637276d0-8c49-46ba-a7a9-8dc52795be8c",
"Name": "sample string 2"
},
"ApplicationStatusDetails": "sample string 5",
"StatusHeading": "sample string 6",
"PriorAccessToExamContent": true,
"ExamEligibilityDate": "2026-05-04T11:11:43.4901798+00:00"
},
{
"ProgramId": "c4542482-7fa1-4999-8227-2cf5b6811fc2",
"ProgramStatus": "sample string 2",
"StatusMessage": "sample string 3",
"ActiveApplicationId": "af645d95-522c-4f8e-9e68-d6f019096463",
"ApplicationStatus": {
"Id": "637276d0-8c49-46ba-a7a9-8dc52795be8c",
"Name": "sample string 2"
},
"ApplicationStatusDetails": "sample string 5",
"StatusHeading": "sample string 6",
"PriorAccessToExamContent": true,
"ExamEligibilityDate": "2026-05-04T11:11:43.4901798+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>af645d95-522c-4f8e-9e68-d6f019096463</ActiveApplicationId>
<ApplicationStatus xmlns:d3p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d3p1:Id>637276d0-8c49-46ba-a7a9-8dc52795be8c</d3p1:Id>
<d3p1:Name>sample string 2</d3p1:Name>
</ApplicationStatus>
<ApplicationStatusDetails>sample string 5</ApplicationStatusDetails>
<ExamEligibilityDate>2026-05-04T11:11:43.4901798+00:00</ExamEligibilityDate>
<PriorAccessToExamContent>true</PriorAccessToExamContent>
<ProgramId>c4542482-7fa1-4999-8227-2cf5b6811fc2</ProgramId>
<ProgramStatus>sample string 2</ProgramStatus>
<StatusHeading>sample string 6</StatusHeading>
<StatusMessage>sample string 3</StatusMessage>
</ContactEligibilityStatus>
<ContactEligibilityStatus>
<ActiveApplicationId>af645d95-522c-4f8e-9e68-d6f019096463</ActiveApplicationId>
<ApplicationStatus xmlns:d3p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d3p1:Id>637276d0-8c49-46ba-a7a9-8dc52795be8c</d3p1:Id>
<d3p1:Name>sample string 2</d3p1:Name>
</ApplicationStatus>
<ApplicationStatusDetails>sample string 5</ApplicationStatusDetails>
<ExamEligibilityDate>2026-05-04T11:11:43.4901798+00:00</ExamEligibilityDate>
<PriorAccessToExamContent>true</PriorAccessToExamContent>
<ProgramId>c4542482-7fa1-4999-8227-2cf5b6811fc2</ProgramId>
<ProgramStatus>sample string 2</ProgramStatus>
<StatusHeading>sample string 6</StatusHeading>
<StatusMessage>sample string 3</StatusMessage>
</ContactEligibilityStatus>
</ArrayOfContactEligibilityStatus>