🚧
This streaming API will cannot currently stream more than 1000 active alerts according to the filter. If the filter returns more than 1000 results, the result set will exclude some items according to the sorting parameters. Items will be added or removed from the result set according sort order and limit as they are updated.

This alert streaming API uses HTTP streaming to send any update to an alert record (including but not limited to location, status and type), according to the filtering, limit and sort order parameters on the request.

The results are returned in atomic 'changeset' XML elements. Each changeset contains a single 'alerts' element, which can contain one or more 'alert' elements, and each 'alert' element contains one updated alert record.

If the 'changeset' element contains the 'clear' property set to 'true', this means any state maintained on the client side (such as a list of active alerts) should be reset/cleared prior to processing any of the 'alert' elements in the changeset. If no client-side state is maintained, this property can be ignored.

If an 'alert' element contains the 'remove' property set to 'true', this means that the alert record has been set removed (resolved) and updates will cease unless the alert is restored.

'subtype' values:
help - the alert was raised using the Help button in SafeZone app, or via the drag-dispatch function in Command using the Help alert type.
firstaid - the alert was raised using the First-Aid button in SafeZone app, or via the drag-dispatch function in Command using the First-Aid alert type.
duress - the alert was raised using the Emergency button in SafeZone app, or via the drag-dispatch function in Command using the Emergency alert type.
checkin - the alert was raised as a result of a check-in timer expiring, or, incapacity detection in SafeZone app.
responder-duress - the alert was raised using the Duress mode in OmniGuard.
ambulance - the alert was raised as a result of the SafeZone app users calling emergency sevices via the First-Aid button while outside of a configured region (this feature must be enabled).
police - the alert was raised as a result of the SafeZone app users calling emergency sevices via the Help or Emergency buttons while outside of a configured region (this feature must be enabled).
incident - the alert was raised via the drag-dispatch function in Command using the Incident alert type.

'status' values:
active - the alert is active and has not yet been acknowledged by the response team or cancelled by the user.
canceled - the alert has not yet been acknowledged by the response team and has been canceled by the user.
acknowledged - the alert has been acknowledged by the response team.
resolved - the alert has been marked as resolved by the response team.

'sort_property' values:
raised - sorts the alerts by the time they were first raised.
update - sorts the alerts by the time they were last updated.
location - sorts the alerts by their last location update time.