InlineAssessmentOrderRequest

🛑

Assessment API Sunset

This API has been deprecated since September 4, 2023. The sunset date is May 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).

Example:

{
    "applicationOperationId": "9ee2f66a-ea6f-11e9-81b4-2a2ae2dbcce4",
    "candidate": {
      "firstName": "John",
      "lastName": "Smith",
      "email": "[email protected]",
      "language": "en"
    },
    "completedAssessmentCallbackUrl": "https://jobs.smartrecruiters.com/oneclick-ui/company/1234/job/4321/publication/5678",
    "assessmentResultUrl": "https://api.smartrecruiters.com/v1/inline-assessments/results/776f584f-1fa6-44f6-8e94-d9daacc3dc3d",
    "partnerClientId": "SmithsRestaurants",
    "partnerInlineAssessmentTypeId": "CooperationSkillsTest",
    "offerCatalogId": "ab-32-gf-asd",
    "job": {
      "uuid": "aaf65646-ed93-4c16-950b-cea69773efba",
        "location": {
        "country": "US",
        "city": "San Francisco",
        "region": "CA",
        "address": "6054 Shook Road"
      },
		"customFields": [
      {
        "fieldId": "5a3a2f5225f6d07d0721e105",
        "fieldLabel": "Brand",
        "valueId": "default",
        "valueLabel": "Silo"
      },
      {
        "fieldId": "COUNTRY",
        "fieldLabel": "Country",
        "valueId": "pl",
        "valueLabel": "Polska"
      }
    ],
    "company": {
        "id": "511a3942300469a9c33819d1",
        "name": "Orlando Magic Inc."
    }
}

Fields description

NameTypeDescription
applicationOperationIdstringIdentifier of a started application process.
candidateobjectCandidate being assessed. Please check InlineAssessmentCandidate object.
completedAssessmentCallbackUrlstringURL which point to last step of an application process. Candidate must be redirected to this URL after completing an assessment.
assessmentResultUrlstringURL which must be used to submit result of an assessment.
partnerClientIdstringIdentifier which allows you to find out which client is requesting an assessment. It can be configured on offer page in Partner Portal.
partnerInlineAssessmentTypeIdstringIdentifier which allows you to find out what type of an assessment is requested. It can be configured on offer page in Partner Portal.
offerCatalogIdstringPartner’s internal identifier of an offer.
jobobjectCompany requesting an assessment. Please check InlineAssessmentJob object.
companyobjectCompany requesting an assessment. Please check InlineAssessmentCompany object.