Scanner connectivity command
Scanner connectivity command messages are used to manage the connections between the scanners and the integrated system.
You can send a single message to either connect, disconnect, or both at the same time. If you send both commands, the disconnecting happens first and then a new connection is initiated.
To disconnect, you must specify it explicitly. If you only send a connection message and the gateway device already has a maximum number of allowed connections, the new connection will not be initiated and you will get an error.
When sending a disconnect message, you must list an array of serial numbers to ensure that the devices with those exact serial numbers are disconnected. If you specify serial numbers of scanners that are not connected is in the disconnect message, they are ignored.
Response: Error event in case of an error.
Name | Type | Description | Accepted values | Constraints | Required |
|---|---|---|---|---|---|
| string | The input API schema version number. |
| Yes | |
| string | The message type. |
| Yes | |
| string | The message identifier. This can be used to reference it. | Any | UUID format | Yes |
| 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 |
| boolean | Initiates a connection with the scanner. |
| Not required if the | |
| string array or string |
|
| If you use an array of serial numbers:
| Not required if the |
Examples
{
"api_version": "1.0",
"event_type": "scanner_connectivity!",
"event_id": "02114da8-feae-46e3-8b00-a3f7ea8672df",
"time_created": 1546300800000,
"disconnect": ["MDMR100000001", "MDMR10000002"],
"connect": true
}{
"api_version": "1.0",
"event_type": "scanner_connectivity!",
"event_id": "02114da8-feae-46e3-8b00-a3f7ea8672df",
"time_created": 1546300800000,
"disconnect": "all",
"connect": true
}