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

# updates package result

`PATCH /orders/{orderId}/results`

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[]
    - `id` string, required
    - `name` string
    - `type` string
    - `contentType` string
    - `actions` object, required
      - `download` Action, required
        - `url` string, required
        - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'OPTIONS' | 'DELETE' | 'HEAD' | 'CONNECT', required
  - `assessmentResults` AssessmentResult[]
    - `attachments` Attachment[]
      - `id` string, required
      - `name` string
      - `type` string
      - `contentType` string
      - `actions` object, required
        - `download` Action, required
          - `url` string, required
          - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'OPTIONS' | 'DELETE' | 'HEAD' | 'CONNECT', required
    - `name` string
    - `status` string
    - `score` string
    - `scoreLabel` string
    - `summary` string

## 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[]
    - `id` string, required
    - `name` string
    - `type` string
    - `contentType` string
    - `actions` object, required
      - `download` Action, required
        - `url` string, required
        - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'OPTIONS' | 'DELETE' | 'HEAD' | 'CONNECT', required
  - `assessmentResults` AssessmentResult[]
    - `attachments` Attachment[]
      - `id` string, required
      - `name` string
      - `type` string
      - `contentType` string
      - `actions` object, required
        - `download` Action, required
          - `url` string, required
          - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'OPTIONS' | 'DELETE' | 'HEAD' | 'CONNECT', required
    - `name` string
    - `status` string
    - `score` string
    - `scoreLabel` string
    - `summary` string

## 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.net/smartrecruiters/apis/apply-api.md) · [All operations](https://skmtc.net/smartrecruiters/apis/apply-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/smartrecruiters/apply-api/revisions/449bdc2516c9/schema)