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": "1d6004bc-02a5-4b69-bfb9-2cbbef0aa790",
"ProgramStatus": "sample string 2",
"StatusMessage": "sample string 3",
"ActiveApplicationId": "c9ec027d-2a7d-4bd3-b85f-d8430018b69d",
"ApplicationStatus": {
"Id": "e3227da3-ea9f-49e3-9281-5c57f67badef",
"Name": "sample string 2"
},
"ApplicationStatusDetails": "sample string 5",
"StatusHeading": "sample string 6",
"PriorAccessToExamContent": true,
"ExamEligibilityDate": "2026-07-04T08:46:59.3554746+00:00"
},
{
"ProgramId": "1d6004bc-02a5-4b69-bfb9-2cbbef0aa790",
"ProgramStatus": "sample string 2",
"StatusMessage": "sample string 3",
"ActiveApplicationId": "c9ec027d-2a7d-4bd3-b85f-d8430018b69d",
"ApplicationStatus": {
"Id": "e3227da3-ea9f-49e3-9281-5c57f67badef",
"Name": "sample string 2"
},
"ApplicationStatusDetails": "sample string 5",
"StatusHeading": "sample string 6",
"PriorAccessToExamContent": true,
"ExamEligibilityDate": "2026-07-04T08:46:59.3554746+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>c9ec027d-2a7d-4bd3-b85f-d8430018b69d</ActiveApplicationId>
<ApplicationStatus xmlns:d3p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d3p1:Id>e3227da3-ea9f-49e3-9281-5c57f67badef</d3p1:Id>
<d3p1:Name>sample string 2</d3p1:Name>
</ApplicationStatus>
<ApplicationStatusDetails>sample string 5</ApplicationStatusDetails>
<ExamEligibilityDate>2026-07-04T08:46:59.3554746+00:00</ExamEligibilityDate>
<PriorAccessToExamContent>true</PriorAccessToExamContent>
<ProgramId>1d6004bc-02a5-4b69-bfb9-2cbbef0aa790</ProgramId>
<ProgramStatus>sample string 2</ProgramStatus>
<StatusHeading>sample string 6</StatusHeading>
<StatusMessage>sample string 3</StatusMessage>
</ContactEligibilityStatus>
<ContactEligibilityStatus>
<ActiveApplicationId>c9ec027d-2a7d-4bd3-b85f-d8430018b69d</ActiveApplicationId>
<ApplicationStatus xmlns:d3p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d3p1:Id>e3227da3-ea9f-49e3-9281-5c57f67badef</d3p1:Id>
<d3p1:Name>sample string 2</d3p1:Name>
</ApplicationStatus>
<ApplicationStatusDetails>sample string 5</ApplicationStatusDetails>
<ExamEligibilityDate>2026-07-04T08:46:59.3554746+00:00</ExamEligibilityDate>
<PriorAccessToExamContent>true</PriorAccessToExamContent>
<ProgramId>1d6004bc-02a5-4b69-bfb9-2cbbef0aa790</ProgramId>
<ProgramStatus>sample string 2</ProgramStatus>
<StatusHeading>sample string 6</StatusHeading>
<StatusMessage>sample string 3</StatusMessage>
</ContactEligibilityStatus>
</ArrayOfContactEligibilityStatus>