ProGlove Documentation

Scan event

Scan event is an event messages that notifies about a scan from a connected scanner.

Fields

Name

Type

Description

Accepted values

Constraints

Required

api_version

string

The input API schema version number

1.0

Yes

event_type

string

The message type.

scan

Yes

event_id

string

The message identifier. This can be used to reference it.

Any

UUID format [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Yes

time_created

integer

The time of creation client-side, used to determine the order of incoming messages. Unix time stamp in milliseconds.

Any

1546300800000 <= value <= 99999999999999

Yes

scan_code

string

The scanned data when the message is of type scan.

Any

1 <= length <= 2000

Yes

device_serial

string

The serial number of a worker device.

Any

1 <= length <= 128

Yes

gateway_serial

string

The serial number of the Gateway

Any

1 <= length <= 128

No

Example
{
  "api_version": "1.0",
  "event_type": "scan",
  "event_id": "02114da8-feae-46e3-8b00-a3f7ea8672df",
  "time_created": 1546300800000,
  "scan_code": "Hello, World!",
  "device_serial": "MDMR000000064",
  "gateway_serial": "PGGW000000058"
}
In this section: