GET /alerts/messages
Retrieves a List of rapid alerts for the given user. The User ID is not passed as a
parameter, but rather is determined by the Device ID in the request header.
Roles that can access this endpoint are Users.
Parameters
| name |
description |
type |
default |
type |
| isConfirmed |
boolean value of is_confirmed, added as a where clause in the query |
query
|
|
Boolean
|
| isRead |
boolean value of is_read, added as a where clause in the query |
query
|
|
Boolean
|
| alertId |
string value defining the type of alerts to be queried, added as a where clause in the query |
query
|
|
String
|
Result
List
<
RowRapidAlertMsg
>
of type:
application/xml
application/json
a list of RowRapidAlertMsg objects
Additional attributes:
__alertDescription This value represents the description of the alert definition. The code for this is found in the rapid_alert_msg.alert_id field.
Child elements:
RowUsers This element represents the user record associated with the value of rapid_alert_msg.entered_by_userid.
This element contains a __name attribute with the value enteredByUser.
Try It Out
Request