Description
Get a particular test link associated with particular test in your accounthttps://api.interviewmocha.com/v2/org/tests/{testId}/testlinks/{testLinkId}
GET
Request Data
Request URL ParametersParameter | Description | Default | Data Type | Is Mandatory |
---|---|---|---|---|
testId | Test Id associated with particular test | None | Int64 | Yes |
testLinkId | Unique Test Link Id | None | Int64 | Yes |
Response Data
ParametersArgument Name | Description | Return Data Type |
---|---|---|
statuscode | Status code returned with every response | String |
description | Status code message | String |
result | Wrapper Object | Object |
result.testId | Unique ID of Test | Int64 |
result.testLinkId | Unique ID of Test Link | Int64 |
result.testLinkName | Identifier of Test Link | String |
result.testLinkAccessKey | Access key associated with Test Link | String |
result.accessTime | Represent access time set for current test link | Int |
result.startDateTime | Represent UTC date time set as access time value | String |
result.endDateTime | Represent UTC date time set as access time value | String |
result.timeZoneId | UTC Time zone id as per Time zone id table | Int |
result.inviteCandidateOnly | Marks whether Test Link is invite only or open test | Int |
result.imageProctoring | Enable image proctoring for test link | Int |
result.emailToStakeholder | Send email to stakeholders when candidate complete the test | String |
result.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/24540'
{
"statuscode": "200.1",
"description": "The request has succeeded.",
"result": {
"testLinkId": 24540,
"testId": 114110,
"testLinkName": "Default",
"testLinkAccessKey": "d3e89987cd",
"accessTime": 0,
"startDateTime": null,
"endDateTime": null,
"timeZoneId": 1720,
"inviteCandidateOnly": 0,
"imageProctoring": 0,
"emailToStakeholder": “test@interviewmocha.com”,
"testLinkStatus": 1
}
}