Live API

GET
Get all tests (/tests)

Return JSON array consisting of all tests created or copied from Test Library by user.

Response Content Type:Application JSON

Request Data

Parameter	Value	Description	Parameter Type	Data Type
page_no		To retrieve test based on page number	Query	Integer
page_size		Number of tests to return per page	Query	Integer

GET
Get test details (/tests/{testId})

Returns the details of a test.

Response Content Type:JSON

Request Data

Parameter	Value	Description	Parameter Type	Data Type
testId		test Id associated with particular test	Query	Int64

Response Body:
```
  
```

POST
Register candidate for test (/tests/{testId}/register)

Register candidate for a test.

Response Content Type:JSON

Request Data

Parameter	Description	Parameter Type	Data Type
testId	test Id associated with particular test	Query	Int64
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

GET
Candidate test report (/report/{testInvitationId})

Get candidate test report for a test given by candidate.

Response Content Type:JSON

Request Data

Parameter	Value	Description	Parameter Type	Data Type
testInvitationId		test Invitation Id associated with candidate giving particular test	Query	Int64

Response Body:

GET
Candidate test section report (/report/{testInvitationId}/sections)

Get candidate section wise report of test.

Response Content Type:JSON

Request Data

Parameter	Value	Description	Parameter Type	Data Type
testInvitationId		test Invitation Id associated with candidate giving particular test	Query	Int64

Response Body:

GET
Export test report as Excel (/report/{testId}/excel)

Export test report in Excel.

Response Content Type:Excel file in HTTP response

Request Data

Parameter	Value	Description	Parameter Type	Data Type
testId		test Id associated with particular test in user's account	Query	Int64

GET
Export candidate report as PDF (/report/{testInvitationId}/pdf)

Export candidate test report in PDF.

Response Content Type:PDF file in HTTP response

Request Data

Parameter	Value	Description	Parameter Type	Data Type
testInvitationId		test Invitation Id associated with particular test in user's account	Query	Int64

POST
Create Test Link (/tests/{testId}/testlinks)

Create new test link for a given test

Response Content Type:JSON

Request Data

Parameter	Description	Parameter Type	Data Type
testId	Test Id associated with particular test	Query	Int64
testLinkName	Name of test link	Body	String
accessTime	Represent access time set for current test link. Zero(0) denotes that test can be accessed anytime	Body	Int


timeZoneId	Time zone in which test should be accessible as per given start datetime and end datetime	Body	Int
inviteCandidateOnly	Candidate invited through email can appear for test	Body	Int
imageProctoring	Enable image proctoring for test link	Body	Int
emailToStakeholder	Send email to stakeholders when candidate complete the test	Body	String
testLinkStatus	Enable or disable test link	Body	Int

POST
Update Test Link (/tests/{testId}/testlinks/{testLinkId})

Modify existing test link settings

Response Content Type:JSON

Request Data

Parameter	Description	Parameter Type	Data Type
testId	Test Id associated with particular test	Query	Int64
testLinkId	Unique Test Link Id	Query	Int64
testLinkName	Name of test link	Body	String
accessTime	Represent access time set for current test link. Zero(0) denotes that test can be accessed anytime	Body	Int


timeZoneId	Time zone in which test should be accessible as per given start datetime and end datetime	Body	Int
inviteCandidateOnly	Candidate invited through email can appear for test	Body	Int
imageProctoring	Enable image proctoring for test link	Body	Int
emailToStakeholder	Send email to stakeholders when candidate complete the test	Body	String
testLinkStatus	Enable or disable test link	Body	Int

GET
Get All Test Links (/tests/{testId}/testlinks)

Get all test links associated with particular test in your account

Response Content Type:JSON

Request Data

Parameter	Value	Description	Parameter Type	Data Type
testId		Test Id associated with particular test	Query	Int64

GET
Get Test Link (/tests/{testId}/testlinks/{testLinkId})

Get a particular test link associated with particular test in your account

Response Content Type:JSON

Request Data

Parameter	Value	Description	Parameter Type	Data Type
testId		Test Id associated with particular test	Query	Int64
testLinkId		Unique Test Link Id	Query	Int64

GET
Cancel Invitation (/testinvitation/{testInvitationId}/cancel)

Cancel test invitations send to candidate

Response Content Type:JSON

Request Data

Parameter	Value	Description	Parameter Type	Data Type
testInvitationId		testInvitationId associated with candidate giving particular test	Query	Int64

GET
Reattempt Test (/testinvitation/{testInvitationId}/reattempt)

Reattempt test

Response Content Type:JSON

Request Data

Parameter	Value	Description	Parameter Type	Data Type
testInvitationId		testInvitationId associated with candidate giving particular test	Query	Int64

POST
Register Candidate By Test Link (/tests/{testId}/testlinks/{testLinkId}/register)

Register candidate for test using specific test link

Response Content Type:JSON

Request Data

Parameter	Description	Parameter Type	Data Type
testId	Test Id associated with particular test	Query	Int64
testLinkId	Unique Test Link Id	Query	Int64
fullName	Full name of candidate	Body	String
emailId	Email Id 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

GET Get all tests (/tests)

GET Get test details (/tests/{testId})

POST Register candidate for test (/tests/{testId}/register)

GET Candidate test report (/report/{testInvitationId})

GET Candidate test section report (/report/{testInvitationId}/sections)

GET Export test report as Excel (/report/{testId}/excel)

GET Export candidate report as PDF (/report/{testInvitationId}/pdf)

POST Create Test Link (/tests/{testId}/testlinks)

POST Update Test Link (/tests/{testId}/testlinks/{testLinkId})

GET Get All Test Links (/tests/{testId}/testlinks)

GET Get Test Link (/tests/{testId}/testlinks/{testLinkId})

GET Cancel Invitation (/testinvitation/{testInvitationId}/cancel)

GET Reattempt Test (/testinvitation/{testInvitationId}/reattempt)

POST Register Candidate By Test Link (/tests/{testId}/testlinks/{testLinkId}/register)

GET
Get all tests (/tests)

GET
Get test details (/tests/{testId})

POST
Register candidate for test (/tests/{testId}/register)

GET
Candidate test report (/report/{testInvitationId})

GET
Candidate test section report (/report/{testInvitationId}/sections)

GET
Export test report as Excel (/report/{testId}/excel)

GET
Export candidate report as PDF (/report/{testInvitationId}/pdf)

POST
Create Test Link (/tests/{testId}/testlinks)

POST
Update Test Link (/tests/{testId}/testlinks/{testLinkId})

GET
Get All Test Links (/tests/{testId}/testlinks)

GET
Get Test Link (/tests/{testId}/testlinks/{testLinkId})

GET
Cancel Invitation (/testinvitation/{testInvitationId}/cancel)

GET
Reattempt Test (/testinvitation/{testInvitationId}/reattempt)

POST
Register Candidate By Test Link (/tests/{testId}/testlinks/{testLinkId}/register)