PATCH
/
unified
/
ats
/
assessments
/
orders
/
{id}
/
result
curl --request PATCH \
  --url https://api.stackone.com/unified/ats/assessments/orders/{id}/result \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'x-account-id: <x-account-id>' \
  --data '{
  "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
  "score": {
    "label": "Percentage",
    "value": "80",
    "min": "0",
    "max": "100"
  },
  "start_date": "2021-01-01T01:01:01.000Z",
  "submission_date": "2021-01-01T01:01:01.000Z",
  "summary": "Test is passed",
  "result": {
    "value": "passed",
    "source_value": "Passed"
  },
  "result_url": "https://exmaple.com/result?id=xyz",
  "attachments": [
    {
      "url": "http://example.com/resume.pdf",
      "content_type": {
        "value": "text",
        "source_value": "Text"
      }
    }
  ],
  "candidate": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "profile_url": "https://exmaple.com/candidate?id=xyz"
  },
  "passthrough": {
    "other_known_names": "John Doe"
  }
}'
{
  "statusCode": 200,
  "message": "Record updated successfully.",
  "timestamp": "2021-01-01T01:01:01.000Z"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

​
x-account-id
string
required

The account identifier

Path Parameters

​
id
string
required

Body

application/json
​
id
string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

​
score
object
​
start_date
string | null

The start date of the candidate test

Example:

"2021-01-01T01:01:01.000Z"

​
submission_date
string | null

The submission date of the candidate test

Example:

"2021-01-01T01:01:01.000Z"

​
summary
string | null

The summary about the result of the test

Example:

"Test is passed"

​
result
object
​
result_url
string | null

The test`s result url

Example:

"https://exmaple.com/result?id=xyz"

​
attachments
object[] | null
​
candidate
object
​
passthrough
object | null

Value to pass through to the provider

Example:
{ "other_known_names": "John Doe" }

Response

200
application/json
The result update of the assessment for candidate.
​
statusCode
number
required
Example:

200

​
message
string
required
Example:

"Record updated successfully."

​
timestamp
string
required
Example:

"2021-01-01T01:01:01.000Z"

Was this page helpful?

Suggest edits
Get Assessments ResultsDelete Background Check Package