Zum Inhalt springen
LabelyardLabelyardLabelyard

Set the manual calibration of a tray

PUT
/api/v1/printers/{printer_id}/calibration/{tray}
curl --request PUT \
  --url https://example.com/api/v1/printers/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/calibration/example \
  --header 'Content-Type: application/json' \
  --header 'X-Label-Hub-Key: <X-Label-Hub-Key>' \
  --data '{ "measured_on": { "type_key": "example", "version": 1 }, "offset_x_mm": 0, "offset_y_mm": 0, "rotation_deg": 0, "scale_x": 1, "scale_y": 1 }'

Authorizations

Abschnitt betitelt „Authorizations“

Parameters

Abschnitt betitelt „Parameters“

Path Parameters

Abschnitt betitelt „Path Parameters“
printer_id
required
Printer Id

Printer id (a page printer).

string format: uuid

Printer id (a page printer).

tray
required
Tray

Tray key.

string
>= 1 characters <= 100 characters

Tray key.

Request Bodyrequired

Abschnitt betitelt „Request Bodyrequired“
Media typeapplication/json
CalibrationPut
object
measured_on

The sheet type version the page was measured on (optional).

Any of:
MeasuredOn
object
type_key
required
Type Key
string
>= 1 characters <= 200 characters
version
required
Version
integer
>= 1 <= 1000000
offset_x_mm
Offset X Mm

Mm; allowed -10.0 to 10.0, at most 2 decimals (checked by the service).

number
0 >= -10 <= 10
offset_y_mm
Offset Y Mm

Mm; allowed -10.0 to 10.0, at most 2 decimals (checked by the service).

number
0 >= -10 <= 10
rotation_deg
Rotation Deg

Degrees, positive is clockwise; allowed -2.0 to 2.0, at most 6 decimals (checked by the service).

number
0 >= -2 <= 2
scale_x
Scale X

Factor; allowed 0.95 to 1.05, at most 6 decimals (checked by the service).

number
default: 1 >= 0.95 <= 1.05
scale_y
Scale Y

Factor; allowed 0.95 to 1.05, at most 6 decimals (checked by the service).

number
default: 1 >= 0.95 <= 1.05

Responses

Abschnitt betitelt „Responses“

200

Abschnitt betitelt „200“

Successful Response

Media typeapplication/json
CalibrationRead

One enabled tray; the values are None while the tray has no calibration (identity).

object
measured_on
Any of:
MeasuredOn
object
type_key
required
Type Key
string
>= 1 characters <= 200 characters
version
required
Version
integer
>= 1 <= 1000000
method
Method
Any of:
string
offset_x_mm
Offset X Mm
Any of:
number
offset_y_mm
Offset Y Mm
Any of:
number
rotation_deg
Rotation Deg
Any of:
number
scale_x
Scale X
Any of:
number
scale_y
Scale Y
Any of:
number
tray
required
Tray
string
updated_at
Updated At
Any of:
string format: date-time
updated_by
Updated By
Any of:
string

Example generated

{
  "measured_on": {
    "type_key": "example",
    "version": 1
  },
  "method": "example",
  "offset_x_mm": 1,
  "offset_y_mm": 1,
  "rotation_deg": 1,
  "scale_x": 1,
  "scale_y": 1,
  "tray": "example",
  "updated_at": "2026-04-15T12:00:00Z",
  "updated_by": "example"
}

422

Abschnitt betitelt „422“

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string

Example generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}