Below V2 API documentation is being deprecated. For latest API docs, visit

Get All Test Links

Description
Get all test links associated with particular test in your account
URL structure

https://api.interviewmocha.com/v2/org/tests/{testId}/testlinks
Request Method

GET

Request Data

Request URL Parameters

Parameter	Description	Default	Data Type	Is Mandatory
testId	Test Id associated with particular test	None	Int64	Yes

Response Data

Parameters

Argument Name	Description	Return Data Type
statuscode	Status code returned with every response	String
description	Status code message	String
result	Wrapper Object	Object
result.testLinks[N].testId	Unique ID of Test	Int64
result.testLinks[N].testLinkId	Unique ID of Test Link	Int64
result.testLinks[N].testLinkName	Identifier of Test Link	String
result.testLinks[N].testLinkAccessKey	Access key associated with Test Link	String
result.testLinks[N].accessTime	Represent access time set for current link	Int
result.testLinks[N].startDateTime	Start date time as per access time option. Please refer to access time tables	String
result.testLinks[N].endDateTime	End date time as per access time option. Please refer to access time tables	String
result.testLinks[N].timeZoneId	UTC Time zone id as per Time zone id table	Int
result.testLinks[N].inviteCandidateOnly	Marks whether Test Link is invite only or open test	Int
result.testLinks[N].imageProctoring	Enable image proctoring for test link	Int
result.testLinks[N].emailToStakeholder	Send email to stakeholders if candidate completes test	String
result.testLinks[N].testLinkStatus	Enable or disable test link	Int

Sample Code

Example Curl request will look like this:

curl -i -H "x-api-key:YOUR_API_KEY_HERE" -H "content-type:application/json;charset=utf-8" -X GET https://api.interviewmocha.com/v2/org/tests/114110/testlinks'

Sample response:

 {
    "statuscode": "200.1",
    "description": "The request has succeeded.",
    "result": {
        "testLinks": [
            {
                "testLinkId": 24540,
                "testId": 114110,
                "testLinkName": "Default",
                "testLinkAccessKey": "d3e89987cd",
                "accessTime": 0,
                "startDateTime": null,
                "endDateTime": null,
                "timeZoneId": 1720,
                "inviteCandidateOnly": 0,
                "imageProctoring": 0,
                "emailToStakeholder": null,
                "testLinkStatus": 1
            },
            {
                "testLinkId": 35044,
                "testId": 114110,
                "testLinkName": "New Link",
                "testLinkAccessKey": "ef776f9145",
                "accessTime": 1,
                "startDateTime": "2018-02-19T01:00:00",
                "endDateTime": "2018-02-20T01:00:00",
                "timeZoneId": 1720,
                "inviteCandidateOnly": 0,
                "imageProctoring": 1,
                "emailToStakeholder": "example@gmail.com",
                "testLinkStatus": 3
            },
            {
                "testLinkId": 35049,
                "testId": 114110,
                "testLinkName": "New Link 1",
                "testLinkAccessKey": "c6ab2bc672",
                "accessTime": 1,
                "startDateTime": "2018-02-19T06:52:36",
                "endDateTime": "2018-02-20T06:52:36",
                "timeZoneId": 1720,
                "inviteCandidateOnly": 0,
                "imageProctoring": 1,
                "emailToStakeholder": "example1@gmail.com",
                "testLinkStatus": 1
            }
      ]
    }
    }
}

Get All Test Links

URL structure

Request Method