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

Get contact elgibility status for each program

Request Information

URI Parameters

NameDescriptionTypeAdditional information
contactId

GUID 00000000-0000-0000-0000-000000000000

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Collection of ContactEligibilityStatus
NameDescriptionTypeAdditional 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": "1f077de7-f969-48e0-8a89-d5b73eea0c44",
    "ProgramStatus": "sample string 2",
    "StatusMessage": "sample string 3",
    "ActiveApplicationId": "f4cebc98-9682-450c-860d-8a0b6273c435",
    "ApplicationStatus": {
      "Id": "525df58a-0eee-4a9b-b9b9-caa4cf760b33",
      "Name": "sample string 2"
    },
    "ApplicationStatusDetails": "sample string 5",
    "StatusHeading": "sample string 6",
    "PriorAccessToExamContent": true,
    "ExamEligibilityDate": "2024-06-18T17:52:38.8920745+00:00"
  },
  {
    "ProgramId": "1f077de7-f969-48e0-8a89-d5b73eea0c44",
    "ProgramStatus": "sample string 2",
    "StatusMessage": "sample string 3",
    "ActiveApplicationId": "f4cebc98-9682-450c-860d-8a0b6273c435",
    "ApplicationStatus": {
      "Id": "525df58a-0eee-4a9b-b9b9-caa4cf760b33",
      "Name": "sample string 2"
    },
    "ApplicationStatusDetails": "sample string 5",
    "StatusHeading": "sample string 6",
    "PriorAccessToExamContent": true,
    "ExamEligibilityDate": "2024-06-18T17:52:38.8920745+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>f4cebc98-9682-450c-860d-8a0b6273c435</ActiveApplicationId>
    <ApplicationStatus xmlns:d3p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
      <d3p1:Id>525df58a-0eee-4a9b-b9b9-caa4cf760b33</d3p1:Id>
      <d3p1:Name>sample string 2</d3p1:Name>
    </ApplicationStatus>
    <ApplicationStatusDetails>sample string 5</ApplicationStatusDetails>
    <ExamEligibilityDate>2024-06-18T17:52:38.8920745+00:00</ExamEligibilityDate>
    <PriorAccessToExamContent>true</PriorAccessToExamContent>
    <ProgramId>1f077de7-f969-48e0-8a89-d5b73eea0c44</ProgramId>
    <ProgramStatus>sample string 2</ProgramStatus>
    <StatusHeading>sample string 6</StatusHeading>
    <StatusMessage>sample string 3</StatusMessage>
  </ContactEligibilityStatus>
  <ContactEligibilityStatus>
    <ActiveApplicationId>f4cebc98-9682-450c-860d-8a0b6273c435</ActiveApplicationId>
    <ApplicationStatus xmlns:d3p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
      <d3p1:Id>525df58a-0eee-4a9b-b9b9-caa4cf760b33</d3p1:Id>
      <d3p1:Name>sample string 2</d3p1:Name>
    </ApplicationStatus>
    <ApplicationStatusDetails>sample string 5</ApplicationStatusDetails>
    <ExamEligibilityDate>2024-06-18T17:52:38.8920745+00:00</ExamEligibilityDate>
    <PriorAccessToExamContent>true</PriorAccessToExamContent>
    <ProgramId>1f077de7-f969-48e0-8a89-d5b73eea0c44</ProgramId>
    <ProgramStatus>sample string 2</ProgramStatus>
    <StatusHeading>sample string 6</StatusHeading>
    <StatusMessage>sample string 3</StatusMessage>
  </ContactEligibilityStatus>
</ArrayOfContactEligibilityStatus>