Neben den Schnittstellen wie dem Alarmserver zur E-Mail Auswertung, gibt es auch die Möglichkeit eine Alarmierung über unsere Web-Schnittstelle auszulösen.

Die URL für die Schnittstelle lautet: https://www.divera247.com/api/alarm?accesskey=API_KEY

Hinweis für Nutzer der kostenlosen Version: In DIVERA 24/7 FREE wird ausschließlich das Einsatzstichwort ausgewertet und übertragen. Ab der ALARM-Version können alle Einsatz-Daten übernommen werden.

Folgende Parameter können via GET oder POST verwendet werden:

Parameter	Bedeutung	Bemerkung
id	Identifier eines bestehenden Datensatzes	Integer, dient dem Zusammenführen/Aktualisieren
number	Nummer	String oder Integer
title	Einsatzstichwort	String, max 50 Zeichen
priority	Priorität/Sonderrechte	String, 0 = aus, 1 = ein
text	Meldung	String
address	Adresse	String, max 200 Zeichen
lng	Breitengrad	Float
lat	Längengrad	Float
coordinates	Anweisung für abweichendes Koordinatensystem	String
coordinates-x	X-Wert der Koordinate	Float
coordinates-y	Y-Wert der Koordinate	Float
ric	Untereinheit(en) und Gruppe(n) gemäß dem Feld Alarmierungs-RIC	String, mehrere Werte mit Komm trennen
person	Person(en) gemäß dem Feld Fremdschlüssel	String, mehrere Werte mit Komm trennen
vehicle	Fahrzeug(e) gemäß dem Feld Alarmierungs-RIC	String, mehrere Werte mit Komm trennen
cluster_ids	IDs von Untereinheiten	Integer als Array
group_ids	IDs von Gruppen	Integer als Array
user_cluster_relation_ids	IDs von Benutzern	Integer als Array
vehicle_ids	IDs von Einsatzfahrzeugen	Integer als Array
delay	Verzögerung seit dem Alarm, in Sekunden	Integer

Nummer (number)

Eigene Nummer des Einsatzes, z.B. laufende Einsatznummer der Leitstelle.

Einsatzstichwort (title)

Das Einsatzstichwort, auf 50 Zeichen begrenzt (bei FREE 30 Zeichen). Wird in der Push Nachricht angezeigt.

Priorität/ Sonderrechte (priority)

Bool/ Wahrheitswert, true oder false

Meldung (text)

Längerer Text mit Detailinformationen. Länge max. 1000 Zeichen

Adresse (address)

Die Adresse, wird zur Darstellung des EInsatzortes auf der Karte verwendet. Länge max. 200 Zeichen

Wenn Sie der Schnittstelle nur die Adresse übergeben und die Koordinaten nicht im Aufruf enthalten sind, versucht die Schnittstelle diese mittels Geocoding zu ermitteln.

Längen- und Breitengrad (lat, lng)

Float-Wert, z.B. 47.4210651 und 10.9766104 für die Zugspitze. Punkt statt Komma verwenden!

Wenn Sie der Schnittstelle nur die Koordinaten übergeben und die Adresse nicht im Aufruf enthalten ist, versucht die Schnittstelle mittels Reverse Geocoding die postalische Adresse zu ermitteln.

Koordinaten im Gauß-Krüger-Format

In Süddeutschland wird in Alarmdepeschen noch häufig das Koordinatensystem Gauß Krüger/Deutsches Hauptdreiecksnetz (DHDN) verwendet.

Zur Kompatibilität mit den verwendeten Karten-Tools (Google Maps, Esri Argis) kann die Web-API Rechts- und Hochwert automatisch in Längen- und Breitengrad (WGS84) umrechnen.

Nutzen Sie folgende Parameter:

coordinates = gk

coordinates-x = Rechtswert

coordinates-y = Hochwert

Die Gauß-Krüger-Zone wird automatisch anhand der hinterlegten Adresse der Einheit ermittelt.

Alarmierte Untereinheiten (ric, cluster_ids)

In der PRO-Version mit einheitsübergreifender Funktionalität können über die zentrale Alarm-Schnittstelle mehrere Untereinheiten mit einem einzigen Aufruf der API alarmiert werden.

Sie können den Parameter "ric" analog zu Gruppen und Fahrzeugen verwenden. Die Datenpflege der "Alarmierungs-RIC" erfolgt jedoch über den zentralen Administrator in den Vorgaben der Untereinheiten.

Der Parameter "cluster_ids" erwartet ein Array mit den Primärschlüsseln der Einheit(en).

Zur schnelleren Verarbeitung wird empfohlen, die IDs der Einheiten als Array zu übergeben.

Alarmierte Untereinheiten und Gruppen (ric, group_ids)

Die Gruppen, die alarmiert werden sollen. Verwenden Sie die Schreibweise aus dem Feld "Alarmierungs-RIC" oder die IDs der gewünschten Gruppen.

Der Parameter "ric" erwartet einen String mit einer oder mehrerer RICs. Mehrere mit Komma getrennt.

Der Parameter "user_cluster_relation_ids" erwartet ein Array mit den Primärschlüsseln der Gruppe(n).

In DIVERA 24/7 PRO können über den API-Key der zentralen Schnittstelle auch einheitsübergreifende Gruppen (z.B. alle Führungskräfte im Stadtgebiet) alarmiert werden.

Alarmierte Personen (person, user_cluster_relation_ids)

Die Benutzer, die alarmiert werden sollen. Verwenden Sie die Schreibweise aus dem Feld "Fremdschlüssel" oder die IDs der gewünschten Einsatzkräfte.

Der Parameter "person" erwartet einen String mit einem oder mehreren Fremdschlüsseln. Mehrere mit Komma getrennt.

Der Parameter "user_cluster_relation_ids" erwartet ein Array mit den Primärschlüsseln der Einsatzkräfte.

Alarmierte Fahrzeuge (vehicle, vehicle_ids)

Die Einsatzmittel, die alarmiert werden sollen. Mehrere mit Komma getrennt. Verwenden Sie die Schreibweise aus dem Feld "Alarmierungs-RIC".

Der Parameter "vehicle" erwartet einen String mit einer oder mehrerer RICs. Mehrere mit Komma getrennt.

Der Parameter "vehicle_ids" erwartet ein Array mit den Primärschlüsseln der Datensätze.

Zeit seit dem Alarm (delay)

Die Sekunden, die seit dem Alarm vergangen sind. Korrigiert die Uhr im Alarmmonitor

Mitteilung statt Alarm auslösen (news)

Über den Parameter "news=1" oder die URL https://www.divera247.com/api/news?accesskey=API_KEY wird eine normale Mitteilung mit leiser Benachrichtigung erzeugt.

Die restlichen Parameter sind weitgehend identisch, es entfallen jedoch Priorität, Koordinaten und Fahrzeuge.

Wichtige Hinweise

Auswertung von Alarmvorlagen

Wenn bei Aufruf der API der Parameter "alarmcode_id" gesetzt ist und einer gültigen Alarmvorlage entspricht, wird diese automatisch angewendet.

Im Regelfall muss jedoch der überlieferte Inhalt auf eine inhaltliche Übereinstimmung untersucht werden. Dafür kann in jeder Alarmvorlage im Reiter "API-Einstellungen" definiert werden, ob und unter welchen Umständen die Vorlage über Texterkennung erkannt wird. Wahlweise gar nicht, nur bei exakter Übereinstimmung mit dem Einsatzstichwort oder wenn bestimmte Suchwörter im überlieferten Einsatzstichwort enthalten sind.

Wenn einzelne Felder, z.B. Text/Meldungen oder die alarmierten Fahrzeuge, explizit im Schnittstellen-Aufruf enthalten sind, werden dies nicht vom Alarmvorschlag überschrieben. Mit der Einstellung "Daten des API-Requests überschreiben" können die Daten aus der Vorlage jedoch auch erzwungen werden.

Die Texterkennung muss zudem in den Einstellungen Verwaltung > Einstellungen > Schnittstellen > Alarmierung > Alarmvorlage anhand des Stichworts erkennen manuell aktiviert werden.

Alarmierung/Mitteilung zusammenfassen

Standardeinstellungen und gezielte Alarmierung

Die API nutzt zur Alarmierung und Benachrichtigung immer die Einstellungen gemäß Verwaltung > Einstellungen > Meldungen > Alarmierungen.

Dort ist einzustellen, über welche Kommunikationswege (App/Push-Nachricht, SMS, Sprachanruf, Pager, E-Mail) der Alarm verschickt wird.

Mittels Filter (aktuelle Fahrzeug-Einteilung und/oder aktueller persönlicher Status) wird eingeschränkt, welche Personen die Alarmierung tatsächlich erhalten.

Weitere Einstellungen sind die Intelligente Alarmierung (SMS/Anruf nur für Personen ohne App-Login) und die Rückfallebene (Überprüfung von Empfangsbestätigung oder Einsatz-Rückmeldung, bei fehlender Bestätigung erfolgt automatisch die Benachrichtigung über einen zweiten Weg, z.B. SMS).

Beschränkung in der kostenlosen Version

Innerhalb des Zeitraums von fünf Minuten kann über die API nur eine Alarmierung ausgelöst werden. Über den API-Request lässt sich nur das Einsatz-Stichwort mit max. 30 Zeichen übertragen.

Ein Upgrade auf die Version ALARM oder PRO bietet viele Vorteile. Die API unterstützt alle Details und verzichtet auf eine zeitliche Limitierung. Über Zusatzmodule wie E-Mail-Auswertung, SMS- und FAX-Inbound können vorhandene Informationskanäle integriert werden. Zur Abbildung vordefinierter Szenarien oder einer Alarm- und Ausrückeordnung (AAO) kann die Schnittstelle außerdem auf Übereinstimmung mit bekannten Alarmvorlagen prüfen und den Einsatz automatisch mit den vordefinierten Eckdaten auslösen.

Einsatz-Rückmeldung

URL: https://www.divera247.com/api/confirm-alarm?accesskey=PERSÖNLICHER_ACCESSKEY