Schnittstelle "Webhook"
Über die Schnittstelle „Webhook“ können Sie aus Drittsystemen über einen standardisierten HTTP-Get Aufruf Informationen an EDP übergeben.
| Funktion | Daten senden | Daten empfangen |
|---|---|---|
| Einsatzdaten | ✔ | |
| Statusmeldungen | ✔ | |
| Positionsmeldungen | ✔ |
✔ = Die Schnittstelle unterstützt diese Funktion. ✘ = die Schnittstelle unterstützt diese Funktion nicht. (Leer) = Entfällt.
Konfiguration
Die Schnittstelle Webhook stellt einen eigenen Webserver bereit, dessen Port im Konfigurationsdialog angegeben werden kann. Weiterhin kann ein Pfad zu einem SSL-Zertifikat sowie der zugehörigen Key-Datei angegeben werden. Werden diese Felder nicht befüllt, wird der Webserver ohne aktive SSL-Verschlüsselung betrieben.
Weiterhin kann ein Token definiert werden, das in jedem HTTP-Get Aufruf enthalten sein muss. Ist ein Token definiert, so werden nur Aufrufe auf die Schnittstelle verarbeitet, die dieses Token mit übermitteln.
Ansteuern der Schnittstelle
Über die Webhook-Schnittstelle können sowohl Einsatzdaten als auch Status- und Positionsmeldungen von Einsatzmitteln über einen HTTP GET-Aufruf an EDP übergeben werden.
Folgende Aufrufe werden dabei unterstützt.
Übergabe von Einsatzdaten
Über den Endpoint „neweinsatz“ können folgende URL-Parameter befüllt werden und damit Einsatzdaten an EDP übergeben werden.
https://{IP}:{PORT}/{TOKEN}/neweinsatz?einsatznummer=...&ort=...&ortsteil=..&einsatzart=F&stichwort=1&einsatzmittel=Rufname1,Rufname2&strasse=Hauptstra%C3%9Fe&hausnummer=11...
Inhalte der Felder Einsatznummer (wird in EDP in das DB-Feld INTERNE_NUMMER geschrieben) sowie EXTERNAL_ID werden zur Identifikation des Einsatzes verwendet, sodass bei mehrfacher Übertragung mit der gleichen Nummer bzw. ID der Einsatz nur aktualisiert wird.
Folgende Felder können übergeben werden:
- INTERNE_NUMMER
- EXTERNAL_ID
- ORT
- ORTSTEIL
- STRASSE
- HAUSNUMMER
- OBJEKTNAME
- EINSATZART
- STICHWORT
- STICHWORT_KLARTEXT
- MELDUNG
- SCHLAGWORT (Als Parameter „meldebild“)
- MELDENDER
- MELDEWEG_TELEFON (Als Parameter „telefon“)
- BEMERKUNG
- KOORDX
- KOORDY
- EINSATZMITTEL (Rufnamen der beteiligten Einsatzmittel durch Komma getrennt)
Wenn in der Konfig-Datei (Via edp:konfig via Rechtsklick auf die Schnittstelle → Grunddaten → Konfig Datei anzeigen) folgender Eintrag ergänzt wurde, können sämtliche Felder der Tabelle EINSAETZE beschrieben werden:
[Webhook] ... DirectParamMappingNewEinsatz=1
Übergabe von Status-Meldungen
Über folgenden Aufruf kann die Status-Meldung eines Einsatzmittels an EDP übergeben werden:
https://{IP}:{PORT}/{TOKEN}/setstatus?issi={ISSI}&status={STATUS}
Beispiel:
https://localhost:454/123/setstatus?issi=1234567&status=4
Hier wird nicht der Rufnahme, sondern die ISSI des Einsatzmittels übermittelt. Diese ISSI muss auch im Einsatzmittel unter Tetrageräte hinterlegt sein und dort der Haken gesetzt sein, dass Status-Meldungen dieses Geräts ausgewertet werden sollen.
Übergabe von GPS-Standortmeldungen
Über folgenden Aufruf kann eine Positionsmeldung an EDP übergeben werden:
https://IP:Port/{TOKEN}/gpsposition?issi={ISSI}&lat={lat}&lon={lon}
Beispiel:
https://localhost:454/123/gpsposition?issi=1234567&lat=49,5&lon=8,2
Auch hier wird nicht der Rufnahme des Einsatzmittels, sondern die ISSI eines Funkgeräts übergeben, das auch für das betreffende Einsatzmittel in den Tetrageräten hinterlegt sein muss. Dort ist ebenfalls der Haken „Status-Meldungen auswerten“ zu setzen.
Endpoints ab edp 2025.01.04
Im Rahmen der Weiterentwicklung werden zusätzliche Endpoints zur Verfügung gestellt, die hier bereits dokumentiert sind:
Übergabe von SDS-Textnachrichten
Über folgenden Aufruf kann eine SDS-Textnachricht an EDP übergeben werden:
https://{IP}:{PORT}/{TOKEN}/incommingsds?issi={ISSI}&text={NACHRICHT}
Beispiel:
https://localhost:454/123/incommingsds?issi=1234567&text=Testnachricht
Die ISSI muss im Einsatzmittel unter Tetrageräte hinterlegt sein.
Übergabe von PTT-Meldungen
Über folgenden Aufruf kann eine PTT-Meldung (Push-To-Talk) an EDP übergeben werden:
https://{IP}:{PORT}/{TOKEN}/incommingptt?issi={ISSI}
Beispiel:
https://localhost:454/123/incommingptt?issi=1234567
Übergabe von Disposition eines Einsatzmittels
Über folgenden Aufruf kann ein Einsatzmittel einem Einsatz zugeordnet werden:
https://{IP}:{PORT}/{TOKEN}/dispoem?rufname={RUFNAME}&einsatznummer={EINSATZNUMMER}
Beispiel:
https://localhost:454/123/dispoem?rufname=Florian1&einsatznummer=12345
Übergabe von BMA-Alarmen
Über folgenden Aufruf kann ein BMA-Alarm (Brandmeldeanlage) an EDP übergeben werden:
https://{IP}:{PORT}/{TOKEN}/incommingbma?ALARMID={ALARMID}&UUID_DATENPUNKT=...&KATEGORIE=...&...
Die Parameter richten sich nach der Konfiguration und können Platzhalter enthalten, die durch die Werte ersetzt werden.
Abfrage der Einsatznummer zu einer BMA-AlarmID
Über folgenden Aufruf kann die Einsatznummer zu einer BMA-AlarmID abgefragt werden:
https://{IP}:{PORT}/{TOKEN}/getbmaenr?alarmid={ALARMID}
Antwort: Die zugehörige Einsatznummer als Text.
Übergabe einer Rückmeldung zu einem Einsatz
Über folgenden Aufruf kann eine Rückmeldung zu einem Einsatz übergeben werden:
https://{IP}:{PORT}/{TOKEN}/newrueckmeldung?einsatznummer={EINSATZNUMMER}&meldender={NAME}&meldeweg={WEG}&eintrag={TEXT}
Alternativ kann auch external_id statt einsatznummer verwendet werden.
Übergabe/Update von Patientendaten zu einem Einsatz
Über folgenden Aufruf können Patientendaten zu einem Einsatz übergeben oder aktualisiert werden:
https://{IP}:{PORT}/{TOKEN}/newpatient?einsatznummer={EINSATZNUMMER}&id={PATIENT_ID}&vorname=...&nachname=...&uhs_patnummer=...
Wird eine id übergeben, erfolgt ein Update des Patienten, sonst ein Insert. Alternativ kann external_id statt einsatznummer verwendet werden. Die Rückgabe erfolgt als JSON mit Status und Patientendaten. Als Felder können alle Felder aus der Tabelle PATIENTEN übergeben werden.
