REST API - CustomEventMessage (Optional)

A Supervisor system (like a WMS or ERP), can display scanned barcode messages on the RaPTr Scanner UI anytime it would like via the CustomEventMessage endpoint. This is useful for displaying custom messages and triggering audible sounds without having to scan a barcode.

Endpoint

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

---

 

Request

Headers
Content-Type: application/json

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

Example JSON Payload:

{
  "LocationID": 1,                               // Unique identifier of the RaPTr unit (unsigned int)
  "ResponseString": "FIRE EXIT BLOCKED",         // Text to display on RaPTr UI (string)
  "ResponseColor": "#FF0000",                    // HTML color code for display (string)
  "DwellTime": 10                                // Duration to display the message in seconds (unsigned int)
}

 

Parameter Types:

• LocationID: unsigned int – Unique identifier of the RaPTr unit.

• ResponseString: string – Text to display on the RaPTr Scanner UI.

• ResponseColor: string – HTML-style color code (e.g., #FF0000) used to render the message.

• DwellTime: unsigned int – Duration in seconds that the message is displayed.

---

 

Response

Success Response
HTTP Status: 200 OK

Response Body:

{
  "ResponseCode": 1,                         // 1 for success, 0 for failure (unsigned int)
  "ResponseString": "Message displayed"      // Message explaining the result (string)
}

 

Parameter Types:

• ResponseCode: unsigned int – Indicates success (1) or failure (0).

• ResponseString: string – Describes the outcome or failure reason.

---

 

Example Flow of Successful Custom Alert

Request:

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

Body:

{
  "LocationID": 2,
  "ResponseString": "PAUSE LOADING – DOOR OPEN",
  "ResponseColor": "#FFA500",
  "DwellTime": 15
}

Response:

{
  "ResponseCode": 1,
  "ResponseString": "Message displayed"
}

---

 

Example Flow of Failed Custom Alert

Request:

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

Body:

{
  "LocationID": 9999,
  "ResponseString": "Label Mismatch",
  "ResponseColor": "#FF0000",
  "DwellTime": 5
}

Response:

{
  "ResponseCode": 0,
  "ResponseString": "Invalid LocationID"
}

---

 

Notes

• This endpoint allows external systems to push custom alerts directly to a RaPTr Scanner UI in real time.

• Use this to indicate time-sensitive or safety-related events.

• Color formatting must be in valid HTML hex format (#RRGGBB).

• DwellTime specifies how long the alert remains visible. A value of 0 may be treated as invalid or ignored, depending on system configuration.