Get the eligibility records for a candidate.

Get's all of the eligibilities associated with the supplied candidate_id. This is useful to decide which specific eligibility needs to be updated or deleted.

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

GET https:///accounts/{account_code}/candidates/{candidate_id}

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 candidate id.

 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
200 OK

All of the eligibilities assocated with the specified candidate id.

 Existing Eligiblity Model[]
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 candidate id.
error_description : No data found for the given candidate id.

Error Model
403 Forbidden

Forbidden operation.

 Error Model
404 Not Found

The specified candidate id 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 candidate id.
Response Content-Type

Choose an authorisation method:

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