Submit assessment results

The API allows you to submit the assessment results when they are ready. Each assessment order can have multiple AssessmentResult objects associated with it. Managing these assessment results is easy and straightforward using the endpoint: /assessments/{assessmentOrderId}/results

Assessment result types

There are 5 assessment result types available in order for you to adjust it to your needs. Each type influences how assessment results are surfaced to customers.

  • DOCUMENT‘ – attach a pdf document as an assessment result
    If a file is not attached, the result for a SmartRecruiters customer will not be displayed.
    You can find more information on how to attach files to results here.
    Value provided in ‘result’ is ignored.
  • VIDEO_URL‘ – send URL to a video interview results being displayed on your web page
    Example: ‘resultType’ = ‘VIDEO_URL’, ‘result’ = ‘https://vendordomain.com/results/resultIdentifier’
  • VIDEO_STREAM‘ – send a URL to video interview results embedded in an HTML file
    Results are packaged in an IFRAME and embedded within SmartRecruiters application
    Example: ‘resultType’ = ‘VIDEO_STREAM’
    Requires a callback URL which works in exactly same way as described below for GENERATED_URL..
  • GENERATED_URL‘ – use a callback URL to dynamically generate assessment, screening results;
    In order to use this resultType, please register the following configs:
    ‘resultURL’ – a URL that will be called each time a SmartRecruiters user opens results; passes orderId information as a parameter (will be added automatically to the given URL), to help identify for which order a URL should be generated
    Example resultURL: https://vendorname.com/assessment/assessmentIdentifier/generateResults?orderId=1342135upo2345iupo
    ‘resultHeader’ – header parameters that will be passed when making the call; usually will contain authentication data.
    Example: authToken: 123456
    Example GET request that SR will perform:

    curl -i -H "authToken: 123456" -X GET https://vendorname.com/assessment/assessmentIdentifier/generateResults?orderId=1342135upo2345iupo

    Value provided in ‘result’ is ignored.

Leaving ‘resultType’ value empty, defaults it to the ‘DOCUMENT’ type.

Note: Ensure that whatever result type you’re submitting, it’s responsive and adjusted to mobile devices. Results you submit are going to be surfaced in responsive version of SmartRecruiters as well as in iOS and Android mobile native apps.

Submit an assessment result

To submit a result for a particular assessment, the following POST request can be used:

curl -i -H "X-SmartToken:abc123" -H "Content-Type: application/json;charset=utf-8" -d @body.json -X POST https://api.smartrecruiters.com/v1/assessments/511a3942300469a9c33819d1/results

body.json:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
    "title": "Enterprise Java Beans test results",
    "description": "Mr. Jet Li demonstrated outstanding Java Skills and we believe he will be a great Senior Java Developer",
    "passed": true,
    "score": "98/100",
    "resultType": "VIDEO_URL",
    "result": "https://vendordomain.com/results/resultIdentifier",
    "author": {
        "firstName": "John",
        "lastName": "Mnemonic",
        "email": "john.mnemonic@smartrecruiters.com",
        "phone": "(123) 321 32 1231"
    }
}

Check results submitted to particular assessment

All results submitted to a particular assessment can be checked using the following GET request:

curl -i -H "X-SmartToken: abc123" -X GET https://api.smartrecruiters.com/v1/assessments/599a3942300469a9c88345d1/results

Response Body:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
{
    "limit": 10,
    "offset": 0,
    "totalFound": 2,
    "content": [
        {
            "id": "511a3942300469a9c33819d8",
            "createDate": "2013-03-08T09:53:44.863+0000",
            "title": "Enterprise Java Beans test results",
            "description": "Mr. Jet Li demonstrated outstanding Java Skills and we believe he will be a great Senior Java Developer",
            "passed": true,
            "score": "98/100",
            "resultType": "VIDEO_URL",
            "result": "https://vendordomain.com/results/resultIdentifier",
            "author": {
                "firstName": "John",
                "lastName": "Mnemonic",
                "email": "john.mnemonic@smartrecruiters.com",
                "phone": "(123) 321 32 1231"
            }
        },
        {
            "id": "511a3942300469a9c33819d8",
            "createDate": "2013-03-08T09:53:44.863+0000",
            "title": "Objec Oriented Programming test results",
            "description": "Mr. Jet Li demonstrated full proficiency in Object Oriented programming",
            "passed": true,
            "score": "95/100",
            "resultType": "URL",
            "result": "https://vendordomain.com/results/resultIdentifier",
            "author": {
                "firstName": "John",
                "lastName": "Mnemonic",
                "email": "john.mnemonic@smartrecruiters.com",
                "phone": "(123) 321 32 1231"
            }
        }
    ]
}