Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Assessment

assessment.addCompletedToCandidate

Add a completed assessment to a candidate.

Requires the candidatesWrite permission.

post/assessment.addCompletedToCandidate

Request body

candidateIdstring uuid required

The id of the candidate to whom to add the completed assessment

partnerIdstring uuid required

The id of the partner adding the assessment

timestampinteger required

The timestamp in milliseconds since the unix epoch when the assessment was completed

Example request

{
  "candidateId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "partnerId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "assessment": {
    "assessmentTypeId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "assessmentId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "assessmentName": "Node Assessment",
    "result": {
      "identifier": "result-max",
      "label": "Max Score",
      "description": "The maximum possible score for the assessment"
    },
    "metadata": [
      {
        "identifier": "result-max",
        "label": "Max Score",
        "description": "The maximum possible score for the assessment"
      }
    ]
  },
  "timestamp": 1665680638489
}

Response

Responses from the assessment.addCompletedToCandidate endpoint

OR

Example response

{
  "success": true,
  "results": {
    "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "assessmentTypeId": "node-assessment",
    "assessmentName": "Node Assessment",
    "assessmentId": "completed-node-assessment",
    "result": {
      "identifier": "result",
      "label": "Score",
      "type": "numeric_score",
      "value": 10
    },
    "metadata": [
      {
        "identifier": "result-max",
        "label": "Max Score",
        "type": "numeric_score",
        "value": 10
      }
    ],
    "applicationId": null,
    "candidateId": "f1e2d3c4-b5a6-4789-9012-3456789abcde"
  }
}