go back Home

AlertService

This service provides access to rapid alert messages. Callers may retrieve messages and mark them read or confirmed.

Operations

name role description
GET /alerts/messageCount Users Returns the number of unread messages across all companies the user is registered in.
GET /alerts/messages Users 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.
GET /alerts/messages/{id} Users Retrieves an RowRapidAlertMsg object for the given rapid alert message ID.
GET /alerts/summary Users Retrieves summary rapid alert information 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.
POST /alerts/messages/confirm Users Marks all rapid alerts as confirmed.
POST /alerts/messages/read Users Marks all messages as read, 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.
POST /alerts/messages/{id}/confirm Users Marks a specific message, as determined by the ID, as confirmed.
POST /alerts/messages/{id}/read Users Marks a specific message, as determined by the ID, as read.