15.2 Schleifen / Schnittstelle
In diesem Bereich kannst Du die Schleifen Deiner Dienststelle pflegen. Um eine neue Schleife anzulegen, benutze die Schaltfläche Schleife anlegen. Mit den Schaltflächen hinter der jeweiligen Schleife kannst du die Details einsehen, die Kontaktzuordnung vornehmen oder die Schleife löschen.
| Dienststelle | Zeigt die Dienststelle an, für die diese Schleife angelegt ist. | automatisch |
| Kurzbezeichnung | Bezeichnung der Schleife (möglichst kurz, denn dies wird auch in PUSH und SMS Nachrichten angezeigt) | Freitext |
| Bemerkung | Beschreibung zur Schleife | Freitext |
| SMS Absenderkennung | Absenderkennung bei SMS Versand (Keine Sonderzeichen, keine Leerzeichen) | Freitext (max 11 Zeichen) |
| Senden an FWdisplay | Auswahl ob die Alarme dieser Schleife an die FWdisplays dieser Dienststelle gesendet werden sollen. | Checkbox |
| Interne Schleife | Vom Benutzer angelegte Schleifen sind immer intern, externe Schleifen werden nur vom FWportal Team angelegt | Checkbox |
| Externe ID | ID, an die Alarme von extern gesendet werden (in Absprache mit FWportal Team zu vergeben) | Freitext |
| Schnittstelle | Auswahl der benutzen Schnittstelle | Auswahl |
| API-Token | Schlüssel, der in der API verwendet werden muss um Missbrauch zu verhindern |
15.2.1 Externe Schleifen
Schleifen können von Extern, z.B. einer Leitstelle, bei uns im System automatisch ausgeführt werden. Externe Schleifen können nur vom FWportal Team eingerichtet werden und sind von außen per E-Mail oder per Web API (z.B. httsp://live.fwportal.de/webapi/alarmapi/sendalarmfromextern) erreichbar.
Das Format der E-Mail oder der Web API richtet sich dabei nach der ausgewählten Schnittstelle. Beschrieben wird hier nur die Datenstruktur der Standard-Schnittstelle.
15.2.1.1 Schnittstelle: Standard (E-Mail Version 1)
Eine externe Schnittstelle kann per E-Mail ausgelöst werden:
Die Externe ID der Schleife dient als E-Mail-Adresse (Beispiel: ExterneID@fwalarm.de) und Identifikation in unserem System.
Adresse:Externe ID@fwalarm.de
Betreff (Subject): API – Token. Dieser dient als Sicherheit, dass die Schleife nur von berechtigten Personen ausgelöst werden kann.
Text (Body): nur Plain Text, kein HTML oder RTF erwartet. Format:
{Einsatznummer} | {Stichwort} | {Straße} | {Hausnummer} | {StrasseZusatz} | {Ort} | {Ortsteil} | {Meldung} | {Koordinate} | {Latitude} | {Longitude} | {Name} | {Objekt} | {Station} | {Melderbemerkung} |
Beispiel Koordinate = „N052°58.37 E008°23.69“, alternativ Latitude = „52.9728“ und Longitude = „8.3948“. Sofern eine Koordinate vorhanden ist, werden die Felder Latitude und Longitude nicht mehr ausgewertet.
Die Felder sind mit dem Zeichen „|“ voneinander zu trennen. Felder die nicht befüllt werden, müssen leer übertragen werden. Das „|“ muss als logische Trennung auf jeden Fall drinbleiben.
15.2.1.2 Schnittstelle: Standard (E-Mail Version 2)
Eine externe Schnittstelle kann per E-Mail ausgelöst werden:
Die Externe ID der Schleife dient als E-Mail-Adresse (Beispiel: ExterneID@fwalarm.de) und Identifikation in unserem System.
Adresse:Externe ID@fwalarm.de
Betreff (Subject): API – Token. Dieser dient als Sicherheit, dass die Schleife nur von berechtigten Personen ausgelöst werden kann.
Text (Body): nur Plain Text, kein HTML oder RTF erwartet. Format:
{AlarmTyp} | {Einsatznummer} | {Stichwort} | {Straße} | {Hausnummer} | {StrasseZusatz} | {Ort} | {Ortsteil} | {Meldung} | {Koordinate} | {Latitude} | {Longitude} | {Name} | {Objekt} | {Station} | {Melderbemerkung} |
Beispiel Koordinate = „N052°58.37 E008°23.69“, alternativ Latitude = „52.9728“ und Longitude = „8.3948“. Sofern eine Koordinate vorhanden ist, werden die Felder Latitude und Longitude nicht mehr ausgewertet.
Die Felder sind mit dem Zeichen „|“ voneinander zu trennen. Felder die nicht befüllt werden, müssen leer übertragen werden. Das „|“ muss als logische Trennung auf jeden Fall drinbleiben.
AlarmTyp 0 = Einsatz, AlarmTyp 1 = Info
15.2.1.3 Schnittstelle: Standard (Web API Version 1)
Eine externe Schnittstelle kann auch per Web API-POST mit einer JSON Struktur ausgelöst werden.
Adresse: https://live.fwportal.de/webapi/alarmapi/sendalarmfromextern
JSON Payload (Beispiel):
{„Absender“:“ToDo“,“ExternID“:“ToDo“,“Token“:“ToDo“,“EinsatznummerLeiststelle“:“OL 4711″,“Stichwort“:“Feuer (F1)“,“Strasse“:“Stockenkamp“,“Hausnummer“:“15″,
„StrasseZusatz“:“Kreuzung“,“Ort“:“Wildeshausen“,“Ortsteil“:“Wildeshausen“,“Meldung“:“Meldung“,“Koordinate“:“N52°54.27 E008°26.32″,“Latitude“:“52.9728″,“Longitude“:“8.3948″,“Name“:Meyer“,“Objekt“:“Turnhalle“,“Station“:“1″,“Bemerkung“:“Melder 47/11″}
Externe ID und Token dienen dabei wieder zur Authentifizierung und Zuordnung der Schleife.
15.2.1.4 Schnittstelle: Standard (Web API Version 2)
Eine externe Schnittstelle kann auch per Web API-POST mit einer JSON Struktur ausgelöst werden.
Adresse: https://live.fwportal.de/webapi/alarmapi/sendalarmfromexternV2
JSON Payload (Beispiel):
{„Absender“:“ToDo“,“ExternID“:“ToDo“,“Token“:“ToDo“,“AlarmTyp“:“0″,“EinsatznummerLeiststelle“:“OL 4711″,“Stichwort“:“Feuer (F1)“,“Strasse“:“Stockenkamp“,“Hausnummer“:“15″,
„StrasseZusatz“:“Kreuzung“,“Ort“:“Wildeshausen“,“Ortsteil“:“Wildeshausen“,“Meldung“:“Meldung“,“Koordinate“:“N52°54.27 E008°26.32″,“Latitude“:“52.9728″,“Longitude“:“8.3948″,“Name“:Meyer“,“Objekt“:“Turnhalle“,“Station“:“1″,“Bemerkung“:“Melder 47/11″}
Externe ID und Token dienen dabei wieder zur Authentifizierung und Zuordnung der Schleife.
AlarmTyp 0 = Einsatz, AlarmTyp 1 = Info