;

API Explorer

  • GET /v3/tests
  • List all tests
Parameter Value Description Parameter Type Data Type
pageNo To retrieve test based on page number Query Integer
pageSize Number of tests to return per page Query Integer
                                
Response
  • GET /v3/tests/:testId
  • Retrieve a test
Parameter Value Description Parameter Type Data Type
testId test Id associated with particular test Query Integer64
 
Response
  • POST /v3/tests/:testId/invite
  • Invite candidate
Parameter Value Description Parameter Type Data Type
testId test Id associated with particular test Query Integer64
emailId Email Id of Candidate Body String
fullName Full name of Candidate Body String
callbackURL Receive candidate test completion notification at your mentioned endpoint Body String
redirectURL Redirect candidate to given URL after test completion Body String
disableMandatoryFields When enabled, email and name fields not required. System auto generates random values both fields. Body Integer
hideInstruction Skips test instruction page Body Integer
imageProctoring Skips test instruction page Body Integer
sendEmail - Body String
 
Response
  • GET /v3/reports/:testInvitationId
  • Retrieve candidate test report
Parameter Value Description Parameter Type Data Type
testInvitationId testInvitationId associated with candidate giving particular test Query Integer64
  
Response
  • GET /v3/reports/:testInvitationId/pdf
  • Retrieve candidate test report in PDF
Parameter Value Description Parameter Type Data Type
testInvitationId testInvitationId associated with candidate giving particular test Query Integer64
  
Response
  • GET /v3/tests/:testId/testlinks
  • List all test links
  • GET /v3/tests/:testId/testlinks/:testLinkId
  • Retrive test link
  • POST /v3/invitations/:testInvitationId/cancel
  • Cancel Invitation
Parameter Value Description Parameter Type Data Type
testInvitationId Unique identifier given to each test attempt Query Integer64
  
Response
  • POST /v3/invitations/:testInvitationId/reattempt
  • Reattempt test
Parameter Value Description Parameter Type Data Type
testInvitationId Unique identifier given to each test attempt Query Integer64
StartDateTime Start datetime in UTC ISO 8601 Format Example: "2020-06-11T16:00:00Z" Format: YYYY-MM-ddTHH:mm:ssZ Body String
EndDateTime End datetime in UTC ISO 8601 Format Example: "2020-06-20T16:00:00Z" Format: YYYY-MM-ddTHH:mm:ssZ Body String
TimeZoneId Timezone id in which invitation will be accessed. Body Integer64
CallbackUrl Receive candidate test completion notification at your mentioned endpoint Body String
RedirectUrl Redirect candidate to given URL after test completion Body String
  
Response
  • POST /v3/tests/{testId}/testlinks/{testLinkId}/invite
  • Invite candidate for test using test link
Parameter Value Description Parameter Type Data Type
testId test Id associated with particular test Query Integer64
testLinkId Unique Test Link Id associated with particular test Query Integer64
emailId Email Id of Candidate Body String
fullName Full name of Candidate Body String
callbackURL After completion of test callback object will be send on this URL Body String
redirectURL After completion of test candidate will redirect to this URL Body String
disableMandatoryFields When enabled, email and name fields not required. System auto generates random values for both fields. Body Integer
hideInstruction Skips test instruction page Body Integer
imageProctoring Overrides the image proctoring settings for current invite. Body Integer
sendEmail When enabled sends test invitation email to candidate.By default disabled Body Integer
  • POST /v3/tests/{testId}/testlinks
  • Create Test Link
  
Response
  • POST /v3/tests/{testId}/testlinks/{testLinkId}
  • Update Test Link
Parameter Value Description Parameter Type Data Type
testId test Id associated with particular test Query Integer64
testLinkId Unique Test Link Id associated with particular test Query Integer64
TestLinkName Name of test link Body String
TestLinkStatus Gives status of given test link as active or inactive Body String
InvitationType Type of invitation link - email or open Body String
ProctoringMode Supported mode - disabled, image, video Body String
StakeholderEmails Comma separated list of emails used to send stakeholders email after candidate test completion Body String
ScheduleType Contains invitation access time settings for validityindays, timebound, slotwise scheduletypes Body String
InvitationValidityInDays Used when scheduleType set to validityindays value. Body Integer
StartDateTime Start datetime in UTC ISO 8601 Format Example: "2020-06-11T16:00:00Z" Format: YYYY-MM-ddTHH:mm:ssZ Body String
EndDateTime End datetime in UTC ISO 8601 Format Example: "2020-06-11T16:00:00Z" Format: YYYY-MM-ddTHH:mm:ssZ Body String
TimeZoneId Timezone id in which invitation will be accessed. Body Integer64
  
Response
  • GET /v3/tests/{testId}/settings
  • Retrieve test settings
Parameter Value Description Parameter Type Data Type
testId test Id associated with particular test Query Integer64
 
Response
  • POST /v3/tests/{testId}/settings
  • Update test settings
Parameter Value Description Parameter Type Data Type
testId test Id associated with particular test Query Integer
testName Name of test Body String
testAliasName test Alias Name of test Body String
typeOfTest typeOfTest 1. Multiple Questions 2. Single Question Body Integer
practiceTest Yes or No. Practice test will have sample questions to familiarize candidates with the test platform. Body Integer
randomQuestions Yes or No Body Integer
randomAnswers Yes or No Body Integer
showQuestionScore Yes or No Body Integer
sectionEndPopup Yes or No Body Integer
sectionTimeLeftAlert Yes or No Body Integer
candidateFeedback Yes or No Body Integer
sendTestReportEmailToCandidate Yes or No Body Integer
terminateTestOnImageViolation Yes or No Body Integer
terminateTestAfterViolationCount Yes or No Body Integer
copyPaste Yes or No Body Integer
displayViolationPopUp Yes or No Body Integer
terminateTestOnWindowViolation Yes or No Body Integer
terminateTestAfterViolationCount Yes or No Body Integer
 
Response
  • POST /v3/candidates/testattempts?state=completed
  • Retrieve completed test attempts
Parameter Value Description Parameter Type Data Type
StartDateTime Start datetime in UTC ISO 8601 Format Example: "2020-06-11T16:00:00Z" Format: YYYY-MM-ddTHH:mm:ssZ Body String
EndDateTime End datetime in UTC ISO 8601 Format Example: "2020-06-11T16:00:00Z" Format: YYYY-MM-ddTHH:mm:ssZ Body String
 
Response
  • POST /v3/callbacks/process
  • Process Callbacks
Parameter Value Description Parameter Type Data Type
testinvitationIds Unique identifier given to each test attempt

Note: Enter multiple testinvitationId seperated by a comma

Body Array of Integer64
 
Response