Scanner state
Scanner state is an event received on scanner connection or disconnection from the Gateway.
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. | scanner_state |
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 |
gateway_serial |
string | The serial number of the Gateway. | Any | 1 <= length <= 128 | Yes |
device_connected_state |
string | The scanner connection state. | STATE_CONNECTED , STATE_DISCONNECTED |
Yes | |
device_disconnect_reason |
string | The reason of the device disconnecting. | UNKNOWN |
if device_connected_state is STATE_DISCONNECTED |
|
device_serial |
string | The serial number of a worker device. | Any | 1 <= length <= 128 | Yes |
Example
{
"api_version": "1.0",
"event_type": "scanner_state",
"event_id": "73f9f3be-01c0-4c2a-9f13-364c96a7ce37",
"time_created": 1546300800000,
"gateway_serial": "PGGW000000058",
"device_connected_state": "STATE_CONNECTED",
"device_disconnect_reason": "UNKNOWN",
"device_serial": "MDMR000000064"
}