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": "b3bd1359-9f74-4e5b-bccb-b39fbe839aef",
"ProgramStatus": "sample string 2",
"StatusMessage": "sample string 3",
"ActiveApplicationId": "5c256ad3-f40c-486e-ae98-4454e193c580",
"ApplicationStatus": {
"Id": "90c0900e-989e-4bd0-ae1f-40a2afefe5cb",
"Name": "sample string 2"
},
"ApplicationStatusDetails": "sample string 5",
"StatusHeading": "sample string 6",
"PriorAccessToExamContent": true,
"ExamEligibilityDate": "2026-08-03T01:33:23.0243071+00:00"
},
{
"ProgramId": "b3bd1359-9f74-4e5b-bccb-b39fbe839aef",
"ProgramStatus": "sample string 2",
"StatusMessage": "sample string 3",
"ActiveApplicationId": "5c256ad3-f40c-486e-ae98-4454e193c580",
"ApplicationStatus": {
"Id": "90c0900e-989e-4bd0-ae1f-40a2afefe5cb",
"Name": "sample string 2"
},
"ApplicationStatusDetails": "sample string 5",
"StatusHeading": "sample string 6",
"PriorAccessToExamContent": true,
"ExamEligibilityDate": "2026-08-03T01:33:23.0243071+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>5c256ad3-f40c-486e-ae98-4454e193c580</ActiveApplicationId>
<ApplicationStatus xmlns:d3p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d3p1:Id>90c0900e-989e-4bd0-ae1f-40a2afefe5cb</d3p1:Id>
<d3p1:Name>sample string 2</d3p1:Name>
</ApplicationStatus>
<ApplicationStatusDetails>sample string 5</ApplicationStatusDetails>
<ExamEligibilityDate>2026-08-03T01:33:23.0243071+00:00</ExamEligibilityDate>
<PriorAccessToExamContent>true</PriorAccessToExamContent>
<ProgramId>b3bd1359-9f74-4e5b-bccb-b39fbe839aef</ProgramId>
<ProgramStatus>sample string 2</ProgramStatus>
<StatusHeading>sample string 6</StatusHeading>
<StatusMessage>sample string 3</StatusMessage>
</ContactEligibilityStatus>
<ContactEligibilityStatus>
<ActiveApplicationId>5c256ad3-f40c-486e-ae98-4454e193c580</ActiveApplicationId>
<ApplicationStatus xmlns:d3p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d3p1:Id>90c0900e-989e-4bd0-ae1f-40a2afefe5cb</d3p1:Id>
<d3p1:Name>sample string 2</d3p1:Name>
</ApplicationStatus>
<ApplicationStatusDetails>sample string 5</ApplicationStatusDetails>
<ExamEligibilityDate>2026-08-03T01:33:23.0243071+00:00</ExamEligibilityDate>
<PriorAccessToExamContent>true</PriorAccessToExamContent>
<ProgramId>b3bd1359-9f74-4e5b-bccb-b39fbe839aef</ProgramId>
<ProgramStatus>sample string 2</ProgramStatus>
<StatusHeading>sample string 6</StatusHeading>
<StatusMessage>sample string 3</StatusMessage>
</ContactEligibilityStatus>
</ArrayOfContactEligibilityStatus>