APITest APIGet Test List

Get Test List

This endpoint generates a list of test reports for the user based on the provided filter criteria.

Endpoint

 POST https://api.ezyhire.com/test/TestReport

Request

Headers
USER-Key: User/API key for authentication
 
Body: json
{
  "pageNumber": 0,
  "pageSize": 0
}
 

Response

Successful Response
Status Code: 200 OK
Content:json
{
 "statusCode": 200,
 "error": "string",
 "message": "Success",
 "data": [
   {
     "email": "string",
     "firstName": "string",
     "lastName": "string",
     "testStatus": "COMPLETED",
     "testId": "string",
     "reportUrl": "string",
     "testName": "string",
     "createdOn": [
       YYYY,
       MM,
       DD,
       HH,
       MM,
       SS,
       NNNNNNN
     ],
     "submittedOn": [
       YYYY,
       MM,
       DD,
       HH,
       MM,
       SS,
       NNNNNNN
     ],
     "numberOfQuestions": 0,
     "idVerificationSessionId": "string",
     "idVerification": false,
     "onboardingStatus": "UNKNOWN",
     "candidate_ATS_Id": "string",
     "testSubStatus": "COMPLETED"
   }
 ]
}

Fields with Enum Values

Field NamePossible Values/Enums
testStatusSENT, IN_PROGRESS, COMPLETED, INACTIVE, ALL
testSubStatusIN_PROGRESS, COMPLETED, INACTIVE, USER_SUBMITTED, SYSTEM_SUBMITTED, IDEAL_SUBMITTED, ALL
onboardingStatusUNKNOWN, ID_VALIDATION_FINISHED, POST_PROCESSING_FINISHED, FACE_VALIDATION_FINISHED, GOVERNMENT_VALIDATION_FINISHED, ONBOARDING_FINISHED, MANUAL_REVIEW_APPROVED, MANUAL_REVIEW_REJECTED
Error Response
Status Code: 400 Bad Request 
Content:json
{
  "Error": "string",
  "ErrorLine": "  \"pageNumber\":0 ,",
  "Location": "Line:0"
}
 
Error Response
Status Code: 401 Unauthorized 
Content:json
{
  "status": 401,
  "message": "Invalid User/API key"
  "error": "Please provide a valid User/API key"
}
 
Error Response
Status Code: 500 Internal Server Error 
Content:json
{
  "statusCode": 500,
  "error": "string",
  "message": "string",
  "data": "string"
}