Раздел API

Весы

Вес на весах и обнуление (ноль или тара).

POST	`/api/v1/scales/{id}/zero`	Обнулить весы
GET	`/api/v1/scales/{id}/weight`	Вес на весах

Обнулить весы#

POST/api/v1/scales/{id}/zero

Операция

Установить ноль или тару — как умеет протокол весов; тело запроса не нужно

Параметры

Имя	Где	Тип	Описание
`id`обязательный	path	integer int32	номер устройства из `GET /api/v1/devices`
`Idempotency-Key`обязательный	header	string
`Prefer`	header	string

Ответ 200 application/json

Поля · Operation

idstring uuid
typestring
idempotencyKeystring
resourcesмассив string
statusstring
значения: QUEUED RUNNING SUCCEEDED FAILED UNKNOWN
stagestring
createdAtstring date-time
startedAtstring date-time
finishedAtstring date-time
resultлюбое значение
errorOperationError
3 поля · OperationError
- codestring
- messagestring
- detailsлюбое значение
warningsмассив string

Ошибки — problem+json с полем code, см. коды ошибок.

Пример запроса

curl

curl -X POST 'http://localhost:7790/api/v1/scales/1/zero' \
  -H 'Idempotency-Key: $(uuidgen)' \
  -H 'Prefer: wait=30'

curl

curl -X POST 'https://cloud.hw-connector.ru/agent/api/v1/scales/1/zero' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42' \
  -H 'Idempotency-Key: $(uuidgen)' \
  -H 'Prefer: wait=30'

Вес на весах#

GET/api/v1/scales/{id}/weight

Сразу, не операция: весы с запросом ждут успокоения груза до нескольких секунд (stable=true). Весы в режиме потока отдают последнее показание; его изменения приходят событием weight

Параметры

Имя	Где	Тип	Описание
`id`обязательный	path	integer int32	номер устройства из `GET /api/v1/devices`

Ответ 200 application/json

Поля · Weight

deviceIdinteger int32
weightnumber
stableboolean
atstring date-time

Ошибки — problem+json с полем code, см. коды ошибок.

Пример запроса

curl

curl 'http://localhost:7790/api/v1/scales/1/weight'

curl

curl 'https://cloud.hw-connector.ru/agent/api/v1/scales/1/weight' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42'