Submit assessment results

🛑

Assessment API Sunset

This API has been deprecated since September 4, 2023. The sunset date is June 10, 2024. If you are an assessment provider or looking to build an assessment integration with SmartRecruiters, please consider using the new Assessment API (2021).

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 attachments

Apart from submitting results, you should also attach file(s) to a result. It’s a required step.
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

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.
  The 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 the SmartRecruiters application
  Example: ‘resultType’ = ‘VIDEO_STREAM’
  Requires a callback URL that works the exact same way as described below for GENERATED_URL.
• GENERATED_URL – use a callback URL to dynamically generate assessment, and 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 of 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 of GET request that SR will perform:
  cURL

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

  The value provided in result is ignored.

Leaving resultType value empty defaults it to the DOCUMENT type.

🚧

Mobile versions

Ensure that whatever result type you’re submitting, it’s responsive and adjusted to mobile devices. The results you submit are going to be surfaced in the responsive version of SmartRecruiter's website 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:

{
    "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": "[email protected]",
        "phone": "(123) 321 32 1231"
    }
}

Note: Up to 100 results can be submitted for a single assessment order.

Check results submitted to a 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:

{
    "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": "[email protected]",
                "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": "[email protected]",
                "phone": "(123) 321 32 1231"
            }
        }
    ]
}