Eligibility Service: Get the test launch URL

API endpoint to retrieve the test launch URL for a given eligibility 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

GET https:///eligibilities/{psi_eligibility_code}/testLaunchInfo

Path parameters

Parameter name	Value	Description	Additional
psi_eligibility_code	string	A unique alphanumeric identifier for this eligibility generated by PSI.	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 Test launch information including the launch url for the given eligibility code.	Test Launch Information
400	Bad Request Below is the list of possible error descriptions in case of bad request or error. scenario : Invalid eligibility code. error_description : Unable to get the account and test details for the given accountCode/testCode.	Error Model
401	Unauthorized You are not authorized to access this resource.	Error Model
403	Forbidden Forbidden operation.	Error Model
500	Internal Server Error Error in case of server errors.	Error Model

Get the test launch URL

API Authentication

Request

Path parameters

Authorisation

Response

Explore this API

Choose an authorisation method:

Request

Response status

Response body

Response headers

psi_eligibility_code		A unique alphanumeric identifier for this eligibility generated by PSI.
Response Content-Type