Zum Inhalt springen
LabelyardLabelyardLabelyard

Mark free cells as used by hand

POST
/api/v1/sheets/{code}/cells/mark
curl --request POST \
  --url https://example.com/api/v1/sheets/example/cells/mark \
  --header 'Content-Type: application/json' \
  --header 'X-Label-Hub-Key: <X-Label-Hub-Key>' \
  --data '{ "cells": [ { "cell": 1, "purpose": "example" } ] }'

Authorizations

Abschnitt betitelt „Authorizations“

Parameters

Abschnitt betitelt „Parameters“

Path Parameters

Abschnitt betitelt „Path Parameters“
code
required
Code

Sheet code, e.g. L4736-0002.

string
<= 24 characters /^[A-Z][A-Z0-9]{1,9}-[0-9]{4,}$/

Sheet code, e.g. L4736-0002.

Request Bodyrequired

Abschnitt betitelt „Request Bodyrequired“
Media typeapplication/json
MarkRequest
object
cells
required
Cells
Array<object>
>= 1 items <= 400 items
MarkedCellIn
object
cell
required
Cell
integer
>= 1
purpose
Purpose

Left out or empty: the cell reads marked by hand.

Any of:

Plain text, at most 120 characters.

string
<= 120 characters

Example generated

{
  "cells": [
    {
      "cell": 1,
      "purpose": "example"
    }
  ]
}

Responses

Abschnitt betitelt „Responses“

200

Abschnitt betitelt „200“

Successful Response

Media typeapplication/json
SheetRead
object
cells
required
Cells

Every cell that is not free, by cell number.

Array<object>
CellRead
object
cell
required
Cell
integer
is_id_cell
required
Is Id Cell

Whether the cell holds the sheet’s ID label (the hub fills it). Set by the hub; do not infer it from source.

boolean
job_id
required
Job Id
Any of:
string format: uuid
marked_by_hand
required
Marked By Hand
boolean
purpose
required
Purpose
Any of:
string
ref
required
Ref
Any of:
string
source
required
Source
string
state
required
State
string
Allowed values: reserved used unconfirmed
updated_at
required
Updated At
Any of:
string
code
required
Code
string
discarded_at
required
Discarded At
Any of:
string
feed_mark_printed
required
Feed Mark Printed

Whether the feed-direction mark has been printed on this sheet.

boolean
free
required
Free
integer
geometry
required
GeometryMm

Geometry of the version the sheet is pinned to.

object
cols
required
Cols
integer
>= 1 <= 400
corner_radius
Corner Radius
Any of:
number
<= 1000
label_h
required
Label H
number
<= 1000
label_w
required
Label W
number
<= 1000
margin_left
required
Margin Left
number
<= 1000
margin_top
required
Margin Top
number
<= 1000
page_h
Page H
Any of:
number
<= 1000
page_size
required
Page Size
string
Allowed values: A4 Letter
page_w
Page W
Any of:
number
<= 1000
pitch_x
required
Pitch X
number
<= 1000
pitch_y
required
Pitch Y
number
<= 1000
rows
required
Rows
integer
>= 1 <= 400
shape
required
Shape
string
Allowed values: rectangle round
id_placement
required
Id Placement
string
Allowed values: cell margin manual
id_printed
required
Id Printed
boolean
label_h
required
Label H
number
label_w
required
Label W
number
last_used_at
required
Last Used At
Any of:
string
note
required
Note
Any of:
string
reserved
required
Reserved
integer
state
required
State
string
Allowed values: active discarded
total
required
Total
integer
type_key
required
Type Key
string
type_label
required
Type Label
string
unconfirmed
required
Unconfirmed
integer
used
required
Used
integer
version
required
Version
integer

Example 

{
  "cells": [
    {
      "state": "reserved"
    }
  ],
  "geometry": {
    "page_size": "A4",
    "shape": "rectangle"
  },
  "id_placement": "cell",
  "state": "active"
}

404

Abschnitt betitelt „404“

Sheet not found.

Media typeapplication/json
object
detail
required
object
error_code
required
string
error_detail
Any of:
object
key
additional properties
any
error_message
required
string

Example generated

{
  "detail": {
    "error_code": "example",
    "error_detail": {},
    "error_message": "example"
  }
}

409

Abschnitt betitelt „409“

Sheet is discarded, or the cells are in the wrong state.

Media typeapplication/json
object
detail
required
object
error_code
required
string
error_detail
Any of:
object
key
additional properties
any
error_message
required
string

Example generated

{
  "detail": {
    "error_code": "example",
    "error_detail": {},
    "error_message": "example"
  }
}

422

Abschnitt betitelt „422“

A cell number is outside the sheet.

Media typeapplication/json
object
detail
required
object
error_code
required
string
error_detail
Any of:
object
key
additional properties
any
error_message
required
string

Example generated

{
  "detail": {
    "error_code": "example",
    "error_detail": {},
    "error_message": "example"
  }
}