---
title: "updates package result"
method: PATCH
path: "/orders/{orderId}/results"
tags: ["result"]
---

# updates package result

`PATCH /orders/{orderId}/results`

## Request

- Base URL: `https://api.smartrecruiters.com/assessment-api/v202010`
- URL: `https://api.smartrecruiters.com/assessment-api/v202010/orders/{orderId}/results`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://api.smartrecruiters.com/identity/oauth/token` scopes: `assessment_result_manage`

Updates results for package ordered. Follows RFC 7396 rules to describe set of modifications.

## Path parameters

- `orderId` string, uuid, required

## Request body

- PackageResult
  - `assessmentPackageDate` string, date-time: The date when assessments package was sent to the candidate
  - `submissionDate` string, date-time: The date when assessments package was submitted by the candidate
  - `name` string
  - `description` string: Not used. To display a short description in the UI, use "summary" instead
  - `status` 'IN_PROGRESS' | 'PENDING' | 'COMPLETED' | 'REJECTED' | 'EXPIRED'
  - `score` Score: Structural score 'raw' value in a range from min to max - including min and max. For example, score {raw:28, min:20, max:80} gives a normalized score of 13%, which users can see in SR UI. The 'raw' value will be converted to SR UI label '28/80' when min value is not provided.
    - `raw` integer, required: Score value
    - `min` integer, required: Range lower bound - included
    - `max` integer, required: Range upper bound - included
  - `scoreLabel` string: Will be displayed next to the score in the candidate profile
  - `summary` string: Will be displayed next to the score and label in the candidate profile
  - `candidateUrl` string: URL with a link to assessment for the candidate
  - `attachments` Attachment[]
    - `type` 'VIDEO_URL' | 'PDF_URL' | 'OTHER_URL', required
    - `url` string, uri, required
  - `assessmentResults` AssessmentResult[]
    - `assessmentId` string, required
    - `assessmentDate` string, date-time
    - `submissionDate` string, date-time
    - `assessmentName` string
    - `score` Score: Structural score 'raw' value in a range from min to max - including min and max. For example, score {raw:28, min:20, max:80} gives a normalized score of 13%, which users can see in SR UI. The 'raw' value will be converted to SR UI label '28/80' when min value is not provided.
      - `raw` integer, required: Score value
      - `min` integer, required: Range lower bound - included
      - `max` integer, required: Range upper bound - included
    - `scoreLabel` string
    - `summary` string
    - `attachments` Attachment[]
      - `type` 'VIDEO_URL' | 'PDF_URL' | 'OTHER_URL', required
      - `url` string, uri, required
    - `status` 'IN_PROGRESS' | 'PENDING' | 'COMPLETED' | 'REJECTED' | 'EXPIRED'

## Response `200`

OK

- PackageResult
  - `assessmentPackageDate` string, date-time: The date when assessments package was sent to the candidate
  - `submissionDate` string, date-time: The date when assessments package was submitted by the candidate
  - `name` string
  - `description` string: Not used. To display a short description in the UI, use "summary" instead
  - `status` 'IN_PROGRESS' | 'PENDING' | 'COMPLETED' | 'REJECTED' | 'EXPIRED'
  - `score` Score: Structural score 'raw' value in a range from min to max - including min and max. For example, score {raw:28, min:20, max:80} gives a normalized score of 13%, which users can see in SR UI. The 'raw' value will be converted to SR UI label '28/80' when min value is not provided.
    - `raw` integer, required: Score value
    - `min` integer, required: Range lower bound - included
    - `max` integer, required: Range upper bound - included
  - `scoreLabel` string: Will be displayed next to the score in the candidate profile
  - `summary` string: Will be displayed next to the score and label in the candidate profile
  - `candidateUrl` string: URL with a link to assessment for the candidate
  - `attachments` Attachment[]
    - `type` 'VIDEO_URL' | 'PDF_URL' | 'OTHER_URL', required
    - `url` string, uri, required
  - `assessmentResults` AssessmentResult[]
    - `assessmentId` string, required
    - `assessmentDate` string, date-time
    - `submissionDate` string, date-time
    - `assessmentName` string
    - `score` Score: Structural score 'raw' value in a range from min to max - including min and max. For example, score {raw:28, min:20, max:80} gives a normalized score of 13%, which users can see in SR UI. The 'raw' value will be converted to SR UI label '28/80' when min value is not provided.
      - `raw` integer, required: Score value
      - `min` integer, required: Range lower bound - included
      - `max` integer, required: Range upper bound - included
    - `scoreLabel` string
    - `summary` string
    - `attachments` Attachment[]
      - `type` 'VIDEO_URL' | 'PDF_URL' | 'OTHER_URL', required
      - `url` string, uri, required
    - `status` 'IN_PROGRESS' | 'PENDING' | 'COMPLETED' | 'REJECTED' | 'EXPIRED'

## Other responses

- `400`: Invalid result partial update provided
- `401`: Unauthorized request
- `403`: Request missed required scopes
- `404`: Order with given id does not exist
- `415`: Unsupported payload format

---

[API](https://skmtc.dev/smartrecruiters/apis/assessment-partner-api.md) - [All operations](https://skmtc.dev/smartrecruiters/apis/assessment-partner-api/llms.txt) - [OpenAPI document](https://skmtc.dev/smartrecruiters/apis/assessment-partner-api/revisions/f7c764bd7c6d?raw)