SAP Gateway API - CustomEventMessage (optional)

Endpoint

POST
http[s]://[RaPTrServerHostname]:[SAPGatewayLocalPort]/SAPCustomEventMessage

---

Purpose

This optional endpoint is used to display a custom message on a RaPTr Scanner UI. The message can be shown in a specified color for a specified duration, along with an optional audible tone.

---

Request

Headers
Content-Type: application/json

Request Body Format
The JSON request must be wrapped in a "d" property.

{
  "d": {
    "LocationID": 12,                      // RaPTr unit identifier (unsigned int)
    "ResponseString": "Manual Check",      // Message to display (string)
    "ResponseColor": "#FFA500",            // Message color (HTML hex code)
    "DwellTime": 3000,                     // Duration in milliseconds (uint)
    "AudibleKey": "alert_3"                // Audible sound key (string)
  }
}

---

Parameter Descriptions:

Field	Type	Description
LocationID	unsigned int	Unique identifier of the RaPTr unit.
ResponseString	string	Text message displayed to the operator.
ResponseColor	string	HTML color code (#RRGGBB) used for the message background.
DwellTime	uint	Duration in milliseconds to display the message. 0 uses scanner default.
AudibleKey	string	Key for the audible alert to be played (optional but recommended).

---

Response

HTTP Status: 200 OK

Response Body:

{
  "d": {
    "ResponseCode": 1,                           // 1 = success, 0 = failure
    "ResponseString": "Message displayed."       // Success/failure information
  }
}

---

Example

Request:

POST http://raptr.local:8055/SAPCustomEventMessage

Body:

{
  "d": {
    "LocationID": 18,
    "ResponseString": "Re-scan Required",
    "ResponseColor": "#FF0000",
    "DwellTime": 5000,
    "AudibleKey": "error_beep"
  }
}

Response:

{
  "d": {
    "ResponseCode": 1,
    "ResponseString": "Message displayed successfully."
  }
}

---

Notes

• Ideal for dynamic operator alerts such as instructions or warning messages.

• Make sure the color and message are legible on your specific scanner UI theme.

• DwellTime is in milliseconds, unlike some other endpoints that use seconds.