REST API - BarcodeReadEvent (required)

When a barcode is read by a RaPTr Scanner, it sends a Barcode Read Event message to its RaPTr Server. The RaPTr Server then relays this message to the REST Server.

Endpoint

POST
[http vs https]://[Supervisor Hostname]:[REST API Supervisor Port (if greater than 0)]/BarcodeReadEvent

---

Request

Headers

• Content-Type: application/json

Request Body

The body of the request should include the following fields in JSON format:

Example JSON Payload:

{
  "WarehouseID": "Warehouse 1",      // Unique identifier of the warehouse (string)
  "Code": "BarcodeXYZ",             // Text encoded in barcode (string)
  "LocationID": 123,           // Identifier of the RaPTr unit (unsigned int)
  "MessageID": 56789,           // Identifier of the barcode read event (unsigned long)
  "CameraID": 1                 // Identifier of the camera which read the barcode (unsigned int)
}

Parameter Types:

• WarehouseID: string – Unique identifier of the warehouse.
• Code: string – The text encoded in the barcode.
• LocationID: unsigned int – The identifier of the RaPTr unit.
• MessageID: unsigned long – The identifier of the barcode read event.
• CameraID: unsigned int – The identifier of the camera that read the barcode.

---

Response

Success Response

HTTP Status: 200 OK

Response Body:

{
  "ResponseCode": 1,            // 1 for correct pallet, 0 for bad pallet (unsigned int)
  "ResponseColor": "#00FF00",   // HTML color code for response display in RaPTr UI (string)
  "ResponseString": "GOOD SCAN!",  // Message for response display in RaPTr UI (string)
  "OrderNumber": "12345",       // Optional identifier of current shipment/order being fulfilled (string)
  "DwellTime": 5000,            // Amount of time the message should remain on the RaPTr Unit screen in milliseconds (unsigned int)
  "AudibleKey": "Good"        // Audible key that designates which sound to play to the operator (string)
}

Parameter Types:

• ResponseCode: unsigned int – A value indicating the result (1 for correct pallet, 0 for bad pallet).
• ResponseColor: string – An HTML-style color code (e.g., #00FF00) for the response display in the RaPTr UI.
• ResponseString: string – A message to be displayed in the RaPTr UI in response to the event.
• OrderNumber: string – An optional identifier for the current shipment/order being fulfilled.
• DwellTime: unsigned int – The amount of time (in milliseconds) the message should remain on the RaPTr Unit screen. A value of 0 will use the default configuration for the scanner.
• AudibleKey: string – The audible key that specifies which sound should play to the operator. Default audibles are "Good" for good scan sound and "Bad" to play an alarm. Additional audibles can be configured within RaPTr Scanner.

---

Example Flow of Positively Scanned Pallet

Request:

POST [http vs https]://[Supervisor Hostname]:[REST API Supervisor Port (if greater than 0)]/BarcodeReadEvent
Content-Type: application/json

{
  "WarehouseID": "WH001",
  "Code": "ABC123",
  "LocationID": 1,
  "MessageID": 1234567890,
  "CameraID": 2
}

Response:

{
  "ResponseCode": 1,
  "ResponseColor": "#00FF00",
  "ResponseString": "SCAN SUCCESS!",
  "OrderNumber": "ORD123",
  "DwellTime": 5000,
  "AudibleKey": "Good"
}

---

Example Flow of Negatively Scanned Pallet

Request:

POST [http vs https]://[Supervisor Hostname]:[REST API Supervisor Port (if greater than 0)]/BarcodeReadEvent
Content-Type: application/json

{
  "WarehouseID": "WH001",
  "Code": "ABC123",
  "LocationID": 1,
  "MessageID": 1234567890,
  "CameraID": 2
}

Response:

{
  "ResponseCode": 0,
  "ResponseColor": "#00FF00",
  "ResponseString": "WRONG DOOR!",
  "OrderNumber": "ORD123",
  "DwellTime": 5000,
  "AudibleKey": "BAD"
}

---

Notes

• ResponseCode of 1 means the scanned pallet is correct, while 0 means the pallet is invalid.
• DwellTime is the amount of time the response message will remain visible on the RaPTr Unit’s screen. If set to 0, the default dwell time will be used.
• AudibleKey corresponds to a sound predefined in the RaPTr system that will alert the operator.