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": "b0dbc5bd-449c-4b58-baa4-a53fa7607a11",
"ProgramStatus": "sample string 2",
"StatusMessage": "sample string 3",
"ActiveApplicationId": "3b6b1ce2-cdff-4b19-99f3-68e108a4aaa1",
"ApplicationStatus": {
"Id": "e5836e7c-3588-4e9d-8760-5e5c195e4aec",
"Name": "sample string 2"
},
"ApplicationStatusDetails": "sample string 5",
"StatusHeading": "sample string 6",
"PriorAccessToExamContent": true,
"ExamEligibilityDate": "2025-12-03T04:42:14.1713527+00:00"
},
{
"ProgramId": "b0dbc5bd-449c-4b58-baa4-a53fa7607a11",
"ProgramStatus": "sample string 2",
"StatusMessage": "sample string 3",
"ActiveApplicationId": "3b6b1ce2-cdff-4b19-99f3-68e108a4aaa1",
"ApplicationStatus": {
"Id": "e5836e7c-3588-4e9d-8760-5e5c195e4aec",
"Name": "sample string 2"
},
"ApplicationStatusDetails": "sample string 5",
"StatusHeading": "sample string 6",
"PriorAccessToExamContent": true,
"ExamEligibilityDate": "2025-12-03T04:42:14.1713527+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>3b6b1ce2-cdff-4b19-99f3-68e108a4aaa1</ActiveApplicationId>
<ApplicationStatus xmlns:d3p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d3p1:Id>e5836e7c-3588-4e9d-8760-5e5c195e4aec</d3p1:Id>
<d3p1:Name>sample string 2</d3p1:Name>
</ApplicationStatus>
<ApplicationStatusDetails>sample string 5</ApplicationStatusDetails>
<ExamEligibilityDate>2025-12-03T04:42:14.1713527+00:00</ExamEligibilityDate>
<PriorAccessToExamContent>true</PriorAccessToExamContent>
<ProgramId>b0dbc5bd-449c-4b58-baa4-a53fa7607a11</ProgramId>
<ProgramStatus>sample string 2</ProgramStatus>
<StatusHeading>sample string 6</StatusHeading>
<StatusMessage>sample string 3</StatusMessage>
</ContactEligibilityStatus>
<ContactEligibilityStatus>
<ActiveApplicationId>3b6b1ce2-cdff-4b19-99f3-68e108a4aaa1</ActiveApplicationId>
<ApplicationStatus xmlns:d3p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d3p1:Id>e5836e7c-3588-4e9d-8760-5e5c195e4aec</d3p1:Id>
<d3p1:Name>sample string 2</d3p1:Name>
</ApplicationStatus>
<ApplicationStatusDetails>sample string 5</ApplicationStatusDetails>
<ExamEligibilityDate>2025-12-03T04:42:14.1713527+00:00</ExamEligibilityDate>
<PriorAccessToExamContent>true</PriorAccessToExamContent>
<ProgramId>b0dbc5bd-449c-4b58-baa4-a53fa7607a11</ProgramId>
<ProgramStatus>sample string 2</ProgramStatus>
<StatusHeading>sample string 6</StatusHeading>
<StatusMessage>sample string 3</StatusMessage>
</ContactEligibilityStatus>
</ArrayOfContactEligibilityStatus>