Sending test assessment orders

πŸ›‘

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).

API allows you to create test AssessmentOrders. These orders are fake and are not attached to any real customer, job, or candidate. Adding fake assessment orders happens through /assessments endpoint.

Generated response is just a mock service and you are not able to perform actions on an order generated that way, e.g. accept or reject it, submit results, etc.

In order to perform an end to end tests, please create a Test Offer, submit it for activation to your test SmartRecruiters customer account, and place an order for that offer from the customer account.

Submit a test assessment order

To submit a test assessment order, you need to send a POST request with a body containing AssessmentOrder object:

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

body.json:

{
    "status": "NEW",
    "requestor": {
        "firstName": "Rob",
        "lastName": "Kaman",
        "email": "[email protected]",
        "phone": "(415) 111-2222"
    },
    "candidate": {
        "id": "e63dfcab300260b2591f585126ede56627db4ef8",
        "firstName": "Mark",
        "lastName": "Hunt",
        "email": "[email protected]",
        "phone": "(415) 111-2222",
        "addressLine": "409 North Magnolia Avenue, Orlando, FL 32801, United States "
    },
    "job": {
        "id": "e63dfcab300260b2591f585126ede56627db4321",
        "name": "Senior Ruby Developer",
        "industry": {
            "id": "computer_software",
            "label": "Computer Software"
        },
        "function": {
            "id": "engineering",
            "label": "Engineering"
        },
        "experienceLevel": {
            "id": "mid_senior_level",
            "label": "senior"
        },
        "location": {
            "country": "US",
            "region": "FL",
            "city": "Orlando"
        }
    },
    "company": {
        "id": "511a3942300469a9c33811d1",
        "name": "Orlando Magic Inc."
    },
    "offer": {
        "catalogId": "bbb-444-111",
        "name": "Senior Ruby Developer Skill Test"
    }
}

POST call above will result in AssessmentOrder object with a unique ID assigned to it. From now on, the new AssessmentOrder can be used to attach results, comments, and send accept, reject, or complete updates.

Response body:

{
    "id": "517e897965320134375cb698",
    "status": "NEW",
    "createDate": "2013-04-29T14:53:45.904+0000",
    "lastUpdateDate": "2013-04-29T14:53:47.100+0000",
    "requestor": {
        "firstName": "Rob",
        "lastName": "Kaman",
        "email": "[email protected]",
        "phone": "(415) 111-2222"
    },
    "candidate": {
        "id": "e63dfcab300260b2591f585126ede56627db4ef8",
        "firstName": "Mark",
        "lastName": "Hunt",
        "email": "[email protected]",
        "phone": "(415) 111-2222",
        "addressLine": ""
    },
    "job": {
        "id": "e63dfcab300260b2591f585126ede56627db4321",
        "industry": {
            "id": "computer_software",
            "label": "Computer Software"
        },
        "function": {
            "id": "engineering",
            "label": "Engineering"
        },
        "experienceLevel": {
            "id": "mid_senior_level",
            "label": "senior"
        },
        "location": {
            "country": "US",
            "city": "Orlando"
        }
    },
    "company": {
        "id": "511a3942300469a9c33811d1",
        "name": "Orlando Magic Inc."
    },
    "offer": {
        "catalogId": "bbb-444-111",
        "name": "Senior Ruby Developer Skill Test"
    }
}