Wie können wir helfen?

Schnittstelle

Du bist hier:

FWportal kann Alarme von externen Quellen empfangen und weiterverarbeiten. Die Auslösung ist per E-Mail-Eingang und per WebAPI Aufruf möglich. Zur Einrichtung externer Schleifen nimm bitte über das Ticketsystem Kontakt mit dem FWportal Team auf.

Im Folgenden werden die Standardschnittstellen zum FWportal beschrieben. Zur direkten Anbindung von Leitstellen können individuelle Lösungen geschaffen werden. Das FWportal Team unterstützt dich hier gerne.

Externe Schleife per E-Mail auslösen

Schnittstelle: Standard (V1) – E-Mail

Adresse: Externe-ID@fwportal.de (=Wird vom FWportal Team vergeben)
Betreff (Subject):
API–Token. (=Wird vom FWportal Team vergeben)
Text (Body):
{Einsatznummer} | {Stichwort} | {Straße} | {Hausnummer} | {StrasseZusatz} | {Ort} | {Ortsteil} | {Meldung} | {Koordinate} | {Latitude} | {Longitude} | {Name} | {Objekt} | {Station} | {Melderbemerkung} | {Einsatzmittel} |

Schnittstelle: Standard (V2) – E-Mail

Adresse: Externe-ID@fwportal.de (=Wird vom FWportal Team vergeben) 
Betreff (Subject):
API–Token. (=Wird vom FWportal Team vergeben)
Text (Body):
{AlarmTyp} | {Einsatznummer} | {Stichwort} | {Straße} | {Hausnummer} | {StrasseZusatz} | {Ort} | {Ortsteil} | {Meldung} | {Koordinate} | {Latitude} | {Longitude} | {Name} | {Objekt} | {Station} | {Melderbemerkung} | {Einsatzmittel} |

Weitere Hinweise zur E-Mail-Schnittstelle:

Die Externe ID der Schleife dient als E-Mail-Adresse (Beispiel: Externe-ID@fwalarm.de).
Der API-Token muss als Betreff (Subject) gesetzt werden und dient als Sicherheit, dass die Schleife nur von berechtigten Personen ausgelöst werden kann.

Externe ID und API-Token werden vom FWportal Team vergeben. Zur Anlage nutze einfach unser Ticketsystem.

Im Body ist nur Plain Text erlaubt. Kein HTML oder RTF.
Sofern eine Koordinate vorhanden ist, werden die Felder Latitude und Longitude nicht mehr ausgewertet.
Format der Koordinaten: „N052°58.37 E008°23.69“, alternativ Latitude = „52.9728“ und Longitude = „8.3948“
Einsatzmittel müssen mit „,“ voneinander getrennt werden.
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 erhalten bleiben.
AlarmTyp 0 = Einsatz, AlarmTyp 1 = Info (Nur bei V2)

Externe Schleife per HTTP-POST-Request auslösen

Schnittstelle: Standard (V1) – Web API

Adresse: https://live.fwportal.de/webapi/alarmapi/sendalarmfromextern
JSON Payload (Feldnamen und Beispielinhalt):
{
„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″,
„Einsatzmittel“:“Fahrzeug 1, Fahrzeug 2″
}

 

Schnittstelle: Standard (V2) – Web API

Adresse: https://live.fwportal.de/webapi/alarmapi/sendalarmfromexternV2
JSON Payload (Feldnamen und Beispielinhalt):
{
„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″,
„Einsatzmittel“:“Fahrzeug 1, Fahrzeug 2″
}

 

Hinweise zur WebAPI

Externe ID und API-Token dienen zur Zuordnung zur Schleife und Authentifizierung und werden vom FWportal Team vergeben. 
AlarmTyp 0 = Einsatz, AlarmTyp 1 = Info (Nur bei V2)
Sofern eine Koordinate vorhanden ist, werden die Felder Latitude und Longitude nicht mehr ausgewertet.
Format der Koordinaten: „N052°58.37 E008°23.69“, alternativ Latitude = „52.9728“ und Longitude = „8.3948“
Einsatzmittel müssen mit „,“ voneinander getrennt werden.