Manage Eligibility Lifecycle

Operation HTTP Request Description
delete
DELETE /accounts/{account_code}/candidates/{candidate_id}/tests/{test_code}
Cancel a candidate's eligibility record.
post
POST /accounts/{account_code}/candidates
Create a new eligibility record.

Retrieve Eligibility Records

Operation HTTP Request Description
get
GET /accounts/{account_code}/candidates/{candidate_id}/eligibilities
Get the eligibilities associated with the candidate id for the specific status (status is the query parameter).
get
GET /accounts/{account_code}/candidates/{candidate_id}/tests/{test_code}
Get the eligibilities associated with the candidate id for the specific test code.
get
GET /accounts/{account_code}/candidates/{candidate_id}
Get the eligibility records for a candidate.

Miscellaneous Actions

Operation HTTP Request Description
put
PUT /accounts/{account_code}/candidates/{candidate_id}/tests/{test_code}/vouchers
Apply a voucher codes to eligibility record.
get
GET /eligibilities/{psi_eligibility_code}/testLaunchInfo
Get the test launch URL
put
PUT /accounts/{account_code}/candidates/{candidate_id}/tests/{test_code}
Update an existing candidate's eligibility record.