GET api/programs/contact/{contactId}/eligibility

Get contact elgibility status for each program

Request Information

URI Parameters

Name	Description	Type	Additional information
contactId	GUID 00000000-0000-0000-0000-000000000000	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Collection of ContactEligibilityStatus

Name	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": "15416c76-9cd2-4537-b1e5-dbf5c42012a2",
    "ProgramStatus": "sample string 2",
    "StatusMessage": "sample string 3",
    "ActiveApplicationId": "a4ced8e0-366e-421a-9090-78a081dd4973",
    "ApplicationStatus": {
      "Id": "27b4614c-df11-4a7b-9640-c41b421ae12e",
      "Name": "sample string 2"
    },
    "ApplicationStatusDetails": "sample string 5",
    "StatusHeading": "sample string 6",
    "PriorAccessToExamContent": true,
    "ExamEligibilityDate": "2024-07-27T04:12:45.2910704+00:00"
  },
  {
    "ProgramId": "15416c76-9cd2-4537-b1e5-dbf5c42012a2",
    "ProgramStatus": "sample string 2",
    "StatusMessage": "sample string 3",
    "ActiveApplicationId": "a4ced8e0-366e-421a-9090-78a081dd4973",
    "ApplicationStatus": {
      "Id": "27b4614c-df11-4a7b-9640-c41b421ae12e",
      "Name": "sample string 2"
    },
    "ApplicationStatusDetails": "sample string 5",
    "StatusHeading": "sample string 6",
    "PriorAccessToExamContent": true,
    "ExamEligibilityDate": "2024-07-27T04:12:45.2910704+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>a4ced8e0-366e-421a-9090-78a081dd4973</ActiveApplicationId>
    <ApplicationStatus xmlns:d3p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
      <d3p1:Id>27b4614c-df11-4a7b-9640-c41b421ae12e</d3p1:Id>
      <d3p1:Name>sample string 2</d3p1:Name>
    </ApplicationStatus>
    <ApplicationStatusDetails>sample string 5</ApplicationStatusDetails>
    <ExamEligibilityDate>2024-07-27T04:12:45.2910704+00:00</ExamEligibilityDate>
    <PriorAccessToExamContent>true</PriorAccessToExamContent>
    <ProgramId>15416c76-9cd2-4537-b1e5-dbf5c42012a2</ProgramId>
    <ProgramStatus>sample string 2</ProgramStatus>
    <StatusHeading>sample string 6</StatusHeading>
    <StatusMessage>sample string 3</StatusMessage>
  </ContactEligibilityStatus>
  <ContactEligibilityStatus>
    <ActiveApplicationId>a4ced8e0-366e-421a-9090-78a081dd4973</ActiveApplicationId>
    <ApplicationStatus xmlns:d3p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
      <d3p1:Id>27b4614c-df11-4a7b-9640-c41b421ae12e</d3p1:Id>
      <d3p1:Name>sample string 2</d3p1:Name>
    </ApplicationStatus>
    <ApplicationStatusDetails>sample string 5</ApplicationStatusDetails>
    <ExamEligibilityDate>2024-07-27T04:12:45.2910704+00:00</ExamEligibilityDate>
    <PriorAccessToExamContent>true</PriorAccessToExamContent>
    <ProgramId>15416c76-9cd2-4537-b1e5-dbf5c42012a2</ProgramId>
    <ProgramStatus>sample string 2</ProgramStatus>
    <StatusHeading>sample string 6</StatusHeading>
    <StatusMessage>sample string 3</StatusMessage>
  </ContactEligibilityStatus>
</ArrayOfContactEligibilityStatus>