Get the eligibilities associated with the candidate id for the specific status (status is the query parameter).

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

Request

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

Path parameters

Parameter name Value Description Additional
account_code string

Provided client specific account code.

 Required
candidate_id string

The candidate id.

 Required

Query parameters

Parameter name Value Description Additional
status string

Status of the candidate eligibilities. Only active, inactive, or all can be passed as status values.

 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 and status.

 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.

scenario : If status is other than active, inactive, or all.
error_description : The request is invalid. Only active, inactive, or all can be passed as values.

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 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.
candidate_id

The candidate id.
status

Status of the candidate eligibilities. Only active, inactive, or all can be passed as status values.
Response Content-Type

Choose an authorisation method:

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