SAP Gateway API - BarcodeReadEvent (required)

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

Endpoint

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

---

Request

Headers
Content-Type: application/json

Request Body
The request must be a JSON object with a single top-level key "d" that contains the actual event data:

Example JSON Payload:

{
  "d": {
    "WarehouseID": "WAREHOUSE_42",    // Unique identifier of the warehouse (string)
    "Code": "1234567890ABC",          // Barcode value scanned (string)
    "LocationID": 7,                  // Identifier of the RaPTr unit that scanned the barcode (unsigned int)
    "MessageID": 987654321,           // Unique identifier for the barcode read event (unsigned long)
    "CameraID": 2                     // Identifier of the camera that performed the scan (unsigned int)
  }
}

Parameter Types:

• WarehouseID: string – Identifies the warehouse the RaPTr unit belongs to.

• Code: string – The raw text scanned from the barcode.

• LocationID: unsigned int – Identifies the RaPTr scanner that captured the barcode.

• MessageID: unsigned long – Unique identifier for this barcode scan event.

• CameraID: unsigned int – ID of the specific camera on the unit that scanned the barcode.

---

Response

Success Response
HTTP Status: 200 OK

Response Body: The response is also wrapped in a top-level "d" key.

{
  "d": {
    "ResponseCode": 1,                      // 1 for valid/correct pallet; 0 for invalid/bad pallet (unsigned int)
    "ResponseColor": "#00FF00",            // HTML color code for response UI message (string)
    "ResponseString": "PALLET ACCEPTED",   // Message to display on RaPTr screen (string)
    "OrderNumber": "ORDER_8899",           // Optional: Order or shipment currently being processed (string)
    "DwellTime": 2500,                     // How long (in ms) to show the message on screen (unsigned int)
    "AudibleKey": "SUCCESS_CHIME"          // Audible cue to be played on scanner (string)
  }
}

Parameter Types:

• ResponseCode: unsigned int – 1 if the barcode corresponds to a valid pallet; 0 if rejected.

• ResponseColor: string – HTML color (#RRGGBB) used for the on-screen response banner.

• ResponseString: string – Human-readable feedback for the operator.

• OrderNumber: string – (Optional) The current shipment or order being fulfilled.

• DwellTime: unsigned int – Duration to display the response message in milliseconds. If 0, scanner defaults apply.

• AudibleKey: string – Identifier for which sound (e.g., success or error chime) to play on the RaPTr device.

---

Example Flow: Valid Barcode

Request:

POST [http vs https]://[Supervisor Hostname]:[REST API Supervisor Port]/BarcodeReadEventURL  

Body:

{
  "d": {
    "WarehouseID": "WH1",
    "Code": "ABC123456",
    "LocationID": 4,
    "MessageID": 12345678,
    "CameraID": 1
  }
}

Response:

{
  "d": {
    "ResponseCode": 1,
    "ResponseColor": "#00FF00",
    "ResponseString": "PALLET VALIDATED",
    "OrderNumber": "ORD10293",
    "DwellTime": 2000,
    "AudibleKey": "CHIME_SUCCESS"
  }
}

---

Example Flow: Invalid Barcode

Response:

{
  "d": {
    "ResponseCode": 0,
    "ResponseColor": "#FF0000",
    "ResponseString": "INVALID PALLET",
    "OrderNumber": "",
    "DwellTime": 3000,
    "AudibleKey": "CHIME_ERROR"
  }
}

---

Notes

• The "d" wrapper is mandatory in both the request and response payloads.

• ResponseColor, ResponseString, and AudibleKey are used to guide the operator’s reaction quickly and clearly.

• Ensure MessageID is unique per scan event to support proper tracking and logging on the server.

• The DwellTime value allows fine-tuned control over UI display behavior; using 0 defers to RaPTr’s default settings.