Live API

Get all tests (/tests)

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

  • 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 test details (/tests/{testId})

Returns the details of a test.

  • Request Data

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

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

Register candidate for a test.

  • Request Data

    Parameter Value 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

Candidate test report (/report/{testInvitationId})

Get candidate test report for a test given by candidate.

  • Request Data

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

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

Get candidate section wise report of test.

  • Request Data

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

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

Export test report in Excel.

  • Request Data

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

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

Export candidate test report in PDF.

  • Request Data

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

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

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

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

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

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

Cancel test invitations send to candidate

  • Request Data

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

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

Reattempt test

  • Request Data

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

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