Cancel a candidate's eligibility record.

Cancels the eligibility matching the supplied candidate eligiblity code.

API Authentication

HTTPS requests to PSI REST APIs are protected with oAuth2 based authentication. To learn more about how PSI handles authentication, please refer to our authentication section

Request

DELETE https:///accounts/{account_code}/candidates/{candidate_id}/tests/{test_code}

Path parameters

Parameter name Value Description Additional
account_code string

Provided client specific account code. This is the unique, randomly generated alphanumeric identifier for the client Account.

 Required
candidate_id string

The unique candidate id to act on.

 Required
test_code string

The test code is the code provided by the client for an exam.

 Required

Authorisation

This request requires the use of one of following authorisation methods: OAuth2.

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
204 No Content

When a candidate's eligibility is successfully canceled.
400 Bad Request


Below is the list of possible error descriptions in case of bad request or error.

scenario : Invalid account code.
error_description : Unable to get the account and test details for the given accountCode/testCode.

scenario : Invalid test code.
error_description : No mapping found for the given test code.

scenario : Invalid candidate code.
error_description : Candidate details not found for the given candidate id.

Error Model
401 Unauthorized

You are not authorized to access this resource.

 Error Model
403 Forbidden

Forbidden operation.

 Error Model
404 Not Found

The specified candidate eligibility code was not found.

 Error Model
500 Internal Server Error

Error in case of server errors.

 Error Model

Explore this API

account_code

Provided client specific account code. This is the unique, randomly generated alphanumeric identifier for the client Account.
candidate_id

The unique candidate id to act on.
test_code

The test code is the code provided by the client for an exam.
Response Content-Type

Choose an authorisation method:

Access Token Access token to be used for request
Try it out!