SAP Gateway API - AlarmEventMessage (optional)

Endpoint

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

---

Purpose

This optional endpoint displays a persistent alarm message on the RaPTr Scanner UI. Alarms remain visible until explicitly cleared using a matching AlarmKey and ActiveStatus set to false.

---

Request

Headers
Content-Type: application/json

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

{
  "d": {
    "LocationID": 42,
    "AckRequired": true,
    "AlarmKey": "door_open",
    "Text": "Dock door left open",
    "Severity": 3,
    "ActiveStatus": true,
    "Time": "2025-04-29T15:12:00Z"
  }
}

---

Request Parameters

Field	Type	Description
LocationID	unsigned int	Unique identifier of the RaPTr unit.
AckRequired	bool	If true, user acknowledgment is required before alarm can be cleared.
AlarmKey	string	Unique identifier for the alarm instance.
Text	string	Text message to be shown in the alarm banner.
Severity	int	Alarm severity level (1 = lowest, 4 = highest).
ActiveStatus	bool	Indicates whether the alarm is active (true) or being cleared (false).
Time	DateTime	ISO 8601 timestamp of when the alarm was generated.

---

Response

HTTP Status: 200 OK

Response Body:

{
  "d": {
    "ResponseCode": 1,
    "ResponseString": "Alarm posted successfully."
  }
}

---

Response Parameters

Field	Type	Description
ResponseCode	unsigned int	1 for success, 0 for failure.
ResponseString	string	Human-readable message about the result.

---

Example

Request:

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

Body:

{
  "d": {
    "LocationID": 42,
    "AckRequired": true,
    "AlarmKey": "zone3_blocked",
    "Text": "Zone 3 conveyor blocked",
    "Severity": 4,
    "ActiveStatus": true,
    "Time": "2025-04-29T17:35:00Z"
  }
}

Response:

{
  "d": {
    "ResponseCode": 1,
    "ResponseString": "Alarm posted successfully."
  }
}