Datenformat Externe Schnittstelle

1 Allgemeine Informationen
- - 1.1.1 Datenformat
- 1.2 Alarmierungen Drittanbieterschnittstelle
  - 1.2.1 Beispiel
- 1.3 Alarme schließen
- 1.4 Statusmeldungen Drittanbieterschnittstelle
  - 1.4.1 Beispiel
- 1.5 Positionsmeldungen Drittanbieterschnittstelle
  - 1.5.1 Beispiel
- 1.6 Lagemeldungen
  - 1.6.1 Beispiel

Allgemeine Informationen

Die Schnittstelle erwartet Daten im JSON-Format und in UTF-8 Codierung.

Datenformat

Diese Anleitung geht nur noch auf das Datenformat v2 ein. Frühere Formate (v1), werden nicht mehr unterstützt.

Alarmierungen status:Drittanbieterschnittstelle

Sie können entweder direkt über eine Liste von Einheiten gezielt einzelne Einheiten alarmieren, oder Sie lassen die Liste units leer, wodurch dann die Standard-Einheiten des Alarmeingangs alarmiert werden.

Beispiel

{
  "type": "ALARM",
  "timestamp": "2021-01-28T08:31:28+01:00",
  "sender": "Leitstelle",
  "authorization": "ABC",
  "data": {
    "externalId": "aaaa-bbbbb-ccccc",
    "keyword": "BMA",
    "keyword_description": "Brandmeldeanlage",
    "keyword_misc": "",
    "message": [
      "Dies ist ein Test"
    ],
    "location": {
      "coordinate": [
        10.123456,
        50.12345
      ],
      "building": "",
      "building_id": "",
      "crossing": "",
      "street": "Musterstraße",
      "house": "10",
      "additional": "",
      "postalCode": "",
      "city": "Musterhausen",
      "city_abbr": "Innenstadt"
    },
    "caller": {
      "name": "Max Mustermann",
      "contact": "0123 45678900"
    },
    "patient": [
      {
        "name": "Martha Mustermann",
        "remark": "",
        "destination": "Universitätsklinikum",
        "patientNumber": "12345"
      }
    ],
    "units": [
      {
        "address":"1234567"
      }
    ],
    "vehicles": [
      {
        "id": "123456",
        "unitType": "",
        "name": "",
        "radioName": "LF 40/1",
        "station": "Hauptwache",
        "alarmedTime": 1528881410000,
        "dispoInfo":"Atemschutzgeräte",
        "jobNumber": "12345",
        "patientNumber": "12345"
      }
    ],
    "custom": {
      "remark": ""
    }
  }
}

Feld	Typ	Beschreibung	Pflichtfeld status:EXTErne schnittstelle	Pflichtfeld status:Drittanbieterschnittstelle

Feld	Typ	Beschreibung
`type`	String	Übergeben Sie hier den Typ ALARM
`sender`	String	Der Sender wird im Alarm gespeichert und kann zur besseren Nachvollziehbarkeit im Alarm verwendet werden
`authorization`	String	Dieses Shared-Secret müssen Sie in FE2 in der Konfiguration des Alarmeingangs im Feld „Gültige Absender“ eintragen. Es muss übereinstimmen, sonst wird der Request abgelehnt.
data	Objekt	Standard-Alarmdaten. Beachten Sie bei den Koordinaten die Reihenfolge! Die erste Koordinaten ist die X-Achse (Longitude), die zweite Koordinate ist die Y-Achse (Latitude).
`custom`	Map<String, String>	Beliebige key-value Zuweisungen Bitte achten Sie darauf, dass Sie den Parameter “custom” in den “data”-Bereich des JSON aufnehmen, sollten Sie weitere Parameter übermitteln wollen.

Es werden die folgenden Werte auf Alarmaktualisierung geprüft:

keyword
vehicles (nur Info nachalarmiert/abgezogen)
units (nur Info nachalarmiert/abgezogen)
Änderungen an den Adressdaten, wie city, street, postalCode etc.
patient (falls in FE2 konfiguriert)

Alarme schließen

Alarme können ebenfalls wieder geschlossen werden.

Nicht verfügbar innerhalb der Drittanbieterschnittstelle.

Beispiel

{
  "type": "CLOSE",
  "timestamp": "2021-01-28T08:31:28+01:00",
  "sender": "Leitstelle",
  "authorization": "ABC",
  "data": {
    "externalId": "aaaa-bbbbb-ccccc",
  }
}

Feld	Typ	Beschreibung	Pflichtfeldstatus:EXTErne schnittstelle

Feld	Typ	Beschreibung
`type`	String	Der Typ der Daten muss hier immer `CLOSE` sein
`timestamp`	String	ISO-Zeitstempel des Alarms
`sender`	String	Absender der Statusmeldung, steht dann als Quelle im Alarm
`authorization`	String	Dieses Shared-Secret müssen Sie in FE2 in der Konfiguration des Alarmeingangs im Feld „Gültige Absender“ eintragen. Es muss übereinstimmen, sonst wird der Request abgelehnt.
`data.externalId`	String	Identifikation welcher Alarm im System geschlossen werden soll

Statusmeldungen status:Drittanbieterschnittstelle

Statusmeldungen von Einsatzmitteln können ebenfalls übermittelt werden.

Beispiel

{
    "type": "STATUS",
    "timestamp": "2021-01-28T08:31:28+01:00",
    "authorization": "ABC",
    "sender": "Leitstelle",
    "data": {
        "status": "2",
        "event": "Wache an",
        "address": "1234567",
        "radioName": "LF 40/1",
        "location": {
            "lat": 48.342424,
            "lng": 10.905622,
            "altitute": 490,
            "accuracy": 10
        }
    }
}

Feld	Typ	Beschreibung	Pflichtfeld status:EXTErne schnittstelle	Pflichtfeld status:Drittanbieterschnittstelle

Feld	Typ	Beschreibung
`type`	String	Der Typ der Daten, hier immer `STATUS`
`timestamp`	String	ISO-Zeitstempel des Alarms
`authorization`	String	Dieses Shared-Secret müssen Sie in FE2 in der Konfiguration des Alarmeingangs im Feld „Gültige Absender“ eintragen. Es muss übereinstimmen, sonst wird der Request abgelehnt.
`sender`	String	Absender der Statusmeldung, steht dann als Quelle im Alarm
`data.status`	String	Fahrzeugstatus
`data.event`	String	Statustext
`data.address`	String	Fahrzeugkennung
`data.radioName`	String	Funkrufname des Fahrzeugs
`data.location.lat`	double	Breitengrad des Einsatzmittels
`data.location.lng`	double	Längengrad des Einsatzmittels
`data.location.altitute`	int	Höhe über NN des Einsatzmittels in Metern
`data.location.accuracy`	int	Genauigkeit der Positionsangabe in Metern

Es wird entweder data.radioName oder data.address benötigt, um das Fahrzeug zu identifizieren. Das andere darf fehlen.

Positionsmeldungen status:Drittanbieterschnittstelle

Beispiel

{
    "authorization": "1234",
    "address": "1234",
    "timestamp": "2022-10-01T12:00:00+02:00",
    "lat": 48.342424,
    "lng": 10.905622,
    "alt": 200,
    "heading": 12.053
}

Feld	Typ	Beschreibung	Pflichtfeld status:EXTErne schnittstelle	Pflichtfeld status:Drittanbieterschnittstelle

Feld	Typ	Beschreibung
`authorization`	String	Dieses Shared-Secret müssen Sie in FE2 in der Konfiguration des Alarmeingangs im Feld „Gültige Absender“ eintragen. Es muss übereinstimmen, sonst wird der Request abgelehnt.
`address`	String	Fahrzeugkennung
`lat`	double	Breitengrad
`lng`	double	Längengrad
`altitude`	long	Höhe über NN des Einsatzmittels in Metern
`heading`	double	Richtung des Fahrzeugs

Lagemeldungen

Beispiel

{
    "authorization": "1234",
    "externalId": "aaaa-bbbbb-ccccc",
    "message": "Nachricht",
    "messageId": "d1a15a6b971c",
    "senderId": "51f5e6a7b9",
    "senderName": "Leitstelle",
    "timestamp": "2022-10-01T12:00:00+02:00",
    "diaryType": "MESSAGE",
    "confidentialState": "CONFIDENTIAL",
    "priority": "DEFAULT"
}

Feld	Typ	Beschreibung	Pflichtfeld status:EXTErne schnittstelle

Feld	Typ	Beschreibung
`authorization`	String	Dieses Shared-Secret müssen Sie in FE2 in der Konfiguration des Alarmeingangs im Feld „Gültige Absender“ eintragen. Es muss übereinstimmen, sonst wird der Request abgelehnt.
`externalId`	String	Einsatznummer des Alarms, anhand derer die Lagekarte gewählt wird
`message`	String	Lagemeldung
`senderName`	String	Absender der Lagemeldung
`messageId`	String	ID der Lagemeldung
`senderId`	String	ID des Absenders
`timestamp`	String	ISO-Zeitstempel der Lagemeldung
Ab status:2.34
`diaryType`	String	Hier kann der Typ der Lagemeldung definiert werden. Gültige Werte sind `MESSAGE` (Nachricht, Standardwert) `CLAIM` (Nachforderung) `REPORT` (Lagemeldung) `FINAL_REPORT` (Abschlussmeldung)
`priority`	String	Hier kann die Priorität der Lagemeldung definiert werden. Gültige Werte sind `DEFAULT` (normale Priorität, Standardwert) `URGENT` (Dringend, hohe Priorität)
`confidentialState`	String	Hier kann die Vertraulichkeit der Lagemeldung definiert werden. Gültige Werte sind `NONE` (keine Vertraulichkeit) `CONFIDENTIAL` (vertraulich, Standardwert)

Handbuch

Datenformat Externe Schnittstelle

Allgemeine Informationen

Datenformat

Alarmierungen status:Drittanbieterschnittstelle

Beispiel

Alarme schließen

Statusmeldungen status:Drittanbieterschnittstelle

Beispiel

Positionsmeldungen status:Drittanbieterschnittstelle

Beispiel

Lagemeldungen

Beispiel

Related content