API Documentation | Xobin Interact

Assessment

List All Assessments

This endpoint is to list all the assessments that are available.

Request URL

GET /<api_key>/assessment/get/assessments

Parameters

No parameters

Path Parameters

api_key

string

API Key obtained from interact.

required

Return Value

array

A list of up to 1000 assessments available for an assessment.

return { } json

an assessment

assessment_id string	The created assessment id
assessment_name string	The title of the assessment

Errors

ValidationError	The parameters passed to the API call are invalid or not provided when required
MethodNotSupported	The requested method is not allowed by the API endpoint.
NotFound	The requested url endpoint is not available
InternalError	An unexpected error occurred processing the request. Interact developers will be notified.

Examples

curl --request GET \
--url https://app.xobin.com/<api_key>/assessment/get/assessments \
--data '{}'

echo '{}' |  \
  http GET https://app.xobin.com/<api_key>/assessment/get/assessments

import requests

url = "https://app.xobin.com/<api_key>/assessment/get/assessments"

payload = "{}"
response = requests.request("GET", url, data=payload)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://app.xobin.com/<api_key>/assessment/get/assessments")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request.body = "{}"

response = http.request(request)
puts response.read_body

var http = require("http");

var options = {
  "method": "GET",
  "hostname": "app.xobin.com",
  "port": null,
  "path": "/<api_key>/assessment/get/assessments",
  "headers": {}
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write("{}");
req.end();

append('{}');

$request->setRequestUrl('https://api-v1.xobin.com/<api_key>/assessment/get/assessments');
$request->setRequestMethod('GET');
$request->setBody($body);

$client->enqueue($request)->send();
$response = $client->getResponse();

echo $response->getBody();

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/octet-stream");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
  .url("https://app.xobin.com/<api_key>/assessment/get/assessments")
  .get()
  .build();

Response response = client.newCall(request).execute();

Send an Assessment Invite

This endpoint is to invite a candidate for a particular assessment and take the assessment

Request URL

GET /<api_key>/assessment/send/invite/<candidate_email>/<candidate_name>/getlink/<assessment_id>

Parameters

No parameters

Path Parameters

api_key	string	API Key obtained from interact.	required
candidate_email	string	The email of the candidate to be invited	required
candidate_name	string	The name of the candidate to be invited	required
assessment_id	string	ID of the assessment you create in Xobin dashboard	required

Return Value

json

Information about the invitation that was sent

_id string	The invitation ID of the candidate
name string	The name of the candidate to whom the invitation was sent
email string	The email of the candidate to whom the invitation was sent
status string	The status of the invitation
testlink URL	The test link for the candidate, through which they can attend the assessment

Errors

ValidationError	The parameters passed to the API call are invalid or not provided when required
MethodNotSupported	The requested method is not allowed by the API endpoint.
NotFound	The requested url endpoint is not available
InternalError	An unexpected error occurred processing the request. Interact developers will be notified.

Examples

Assuming the assessment ID is BDA.K-4dsfsG8I3Bsa, candidate name is John Doe and his email is [email protected]

curl --request GET \
--url https://app.xobin.com/<api_key>/assessment/send/invite/[email protected]/John-Doe/getlink/BDA.K-4dsfsG8I3Bsa \
--data '{}'

echo '{}' |  \
  http GET https://app.xobin.com/<api_key>/assessment/send/invite/[email protected]/John-Doe/getlink/BDA.K-4dsfsG8I3Bsa

import requests

url = "https://app.xobin.com/<api_key>/assessment/send/invite/[email protected]/John-Doe/getlink/BDA.K-4dsfsG8I3Bsa"

payload = '{}'
response = requests.request("GET", url)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://app.xobin.com/<api_key>/assessment/send/invite/[email protected]/John-Doe/getlink/BDA.K-4dsfsG8I3Bsa")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::GET.new(url)
request.body = '{}'

response = http.request(request)
puts response.read_body

var http = require("http");

var options = {
  "method": "GET",
  "hostname": "app.xobin.com",
  "port": null,
  "path": "<api_key>/assessment/send/invite/[email protected]/John-Doe/getlink/BDA.K-4dsfsG8I3Bsa",
  "headers": {}
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write('{}');
req.end();

<?php

$client = new http\Client;
$request = new http\Client\Request;

$body = new http\Message\Body;
$body->append('{}');

$request->setRequestUrl('https://app.xobin.com/<api_key>/assessment/send/invite/[email protected]/John-Doe/getlink/BDA.K-4dsfsG8I3Bsa');
$request->setRequestMethod('GET');
$request->setBody($body);

$client->enqueue($request)->send();
$response = $client->getResponse();

echo $response->getBody();
?>

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/octet-stream");
RequestBody body = RequestBody.create(mediaType, '{}');
Request request = new Request.Builder()
  .url("https://app.xobin.com/<api_key>/assessment/send/invite/[email protected]/John-Doe/getlink/BDA.K-4dsfsG8I3Bsa")
  .get()
  .build();

Response response = client.newCall(request).execute();

Get Candidate Score in Assessment

This endpoint is to fetch the score report of a candidate who has completed a particular assessment.

Request URL

GET /<api_key>/assessment/get/report/<candidate_id>

Parameters

No parameters

Path Parameters

api_key	string	API Key obtained from interact.	required
candidate_id	string	The invite ID of the candidate for whom the score must be fetched. Refer Send Assessment Invite to see how the candidate ID is generated	required

Return Value

json

Information about the candidate, the assessment and the score report

name string	The name of the candidate
email string	The email of the candidate
cutoff number	The cutoff percentage to pass the specified assessment
completed_date timestamp	The date and time of completion of the assessment by the candidate
overall_percentage number	The overall score of the candidate in the specified assessment
sections JSON	The marks scored by the candidate within the different sections of the assessment, if any. It is of the format section_name: section_marks

Errors

ValidationError	The parameters passed to the API call are invalid or not provided when required
MethodNotSupported	The requested method is not allowed by the API endpoint.
NotFound	The requested url endpoint is not available
InternalError	An unexpected error occurred processing the request. Interact developers will be notified.

Examples

Assuming the candidate ID is 77576

curl --request GET \
--url https://app.xobin.com/<api_key>/assessment/get/report/77576 \
--data '{}'

echo '{}' |  \
  http GET https://app.xobin.com/<api_key>/assessment/get/report/77576

import requests

url = "https://app.xobin.com/<api_key>/assessment/get/report/77576"

payload = "{}"
response = requests.request("GET", url, data=payload)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://app.xobin.com/<api_key>/assessment/get/report/77576")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request.body = "{}"

response = http.request(request)
puts response.read_body

var http = require("http");

var options = {
  "method": "GET",
  "hostname": "app.xobin.com",
  "port": null,
  "path": "/<api_key>/assessment/get/report/77576",
  "headers": {}
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write("{}");
req.end();

append('{}');

$request->setRequestUrl('https://app.xobin.com/<api_key>/assessment/get/report/77576');
$request->setRequestMethod('GET');
$request->setBody($body);

$client->enqueue($request)->send();
$response = $client->getResponse();

echo $response->getBody();

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/octet-stream");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
  .url("https://app.xobin.com/<api_key>/assessment/get/report/77576")
  .get()
  .build();

Response response = client.newCall(request).execute();

Get List of Invited Candidates

This endpoint is to get the list of all the candidates invited to a specified assessment.

Request URL

GET /<api_key>/assessment/get/candidates/<assessment_id>

Parameters

No parameters

Path Parameters

api_key	string	API Key obtained from interact.	required
assessment_id	string	The ID of the assessment for which the candidate list must be fetched Refer List All Assessment to find out the assessment ID using the name of the assessment.	required

Return Value

json

Information about all the candidates invited to the assessment specified

<candidate_id> json

The particular candidate's information

email string	The email of the candidate
name string	The name of the candidate

Errors

ValidationError	The parameters passed to the API call are invalid or not provided when required
MethodNotSupported	The requested method is not allowed by the API endpoint.
NotFound	The requested url endpoint is not available
InternalError	An unexpected error occurred processing the request. Interact developers will be notified.

Examples

Assuming the assessment ID is 5902

curl --request GET \
--url https://app.xobin.com/<api_key>/assessment/get/candidates/5902 \
--data '{}'

echo '{}' |  \
  http GET https://app.xobin.com/<api_key>/assessment/get/candidates/5902

import requests

url = "https://app.xobin.com/<api_key>/assessment/get/candidates/5902"

payload = "{}"
response = requests.request("GET", url, data=payload)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://app.xobin.com/<api_key>/assessment/get/candidates/5902")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request.body = "{}"

response = http.request(request)
puts response.read_body

var http = require("http");

var options = {
  "method": "GET",
  "hostname": "app.xobin.com",
  "port": null,
  "path": "/<api_key>/assessment/get/candidates/5902",
  "headers": {}
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write("{}");
req.end();

append('{}');

$request->setRequestUrl('https://app.xobin.com/<api_key>/assessment/get/candidates/5902');
$request->setRequestMethod('GET');
$request->setBody($body);

$client->enqueue($request)->send();
$response = $client->getResponse();

echo $response->getBody();

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/octet-stream");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
  .url("https://app.xobin.com/<api_key>/assessment/get/candidates/5902")
  .get()
  .build();

Response response = client.newCall(request).execute();

Get Count of Live Test-Takers

This endpoint is to get the count of test takers currently taking assessments.

Request URL

GET /<api_key>/assessment/get/live

Parameters

No parameters

Path Parameters

api_key

string

API Key obtained from interact.

required

Return Value

json

Information about the number of candidates taking live test

live_test_takers number

The number of test takers currently taking the test

Errors

ValidationError	The parameters passed to the API call are invalid or not provided when required
MethodNotSupported	The requested method is not allowed by the API endpoint.
NotFound	The requested url endpoint is not available
InternalError	An unexpected error occurred processing the request. Interact developers will be notified.

Examples

curl --request GET \
--url https://app.xobin.com/<api_key>/assessment/get/live \
--data '{}'

echo '{}' |  \
  http GET https://app.xobin.com/<api_key>/assessment/get/live

import requests

url = "https://app.xobin.com/<api_key>/assessment/get/live"

payload = "{}"
response = requests.request("GET", url, data=payload)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://app.xobin.com/<api_key>/assessment/get/live")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request.body = "{}"

response = http.request(request)
puts response.read_body

var http = require("http");

var options = {
  "method": "GET",
  "hostname": "app.xobin.com",
  "port": null,
  "path": "/<api_key>/assessment/get/live",
  "headers": {}
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write("{}");
req.end();

append('{}');

$request->setRequestUrl('https://app.xobin.com/<api_key>/assessment/get/live');
$request->setRequestMethod('GET');
$request->setBody($body);

$client->enqueue($request)->send();
$response = $client->getResponse();

echo $response->getBody();

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/octet-stream");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
  .url("https://app.xobin.com/<api_key>/assessment/get/live")
  .get()
  .build();

Response response = client.newCall(request).execute();

Sample Response

curl --request GET \
--url https://app.xobin.com/<api_key>/assessment/get/live \
--data '{}'