Die Schnittstelle erwartet Daten im JSON
-Format und in UTF-8
Codierung.
Diese Anleitung geht nur noch auf das Datenformat v2 ein. Frühere Formate (v1), werden nicht mehr unterstützt. |
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.
{ "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": [ 30.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 | Pflichtfeld
| |
---|---|---|---|---|---|
| String | Übergeben Sie hier den Typ ALARM |
| ||
| String | Der Sender wird im Alarm gespeichert und kann zur besseren Nachvollziehbarkeit im Alarm verwendet werden |
| ||
| 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. | |||
| Map<String, String> | Beliebige key-value Zuweisungen
|
Ab der Version 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 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 | Pflichtfeld |
---|---|---|---|
| String | Der Typ der Daten muss hier immer | |
| String | ISO-Zeitstempel des Alarms | |
| String | Absender der Statusmeldung, steht dann als Quelle im Alarm | |
| 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. | |
| String | Identifikation welcher Alarm im System geschlossen werden soll |
Statusmeldungen von Einsatzmitteln können ebenfalls übermittelt werden.
{ "type": "STATUS", "timestamp": "2021-01-28T08:31:28+01:00", "sender": "Leitstelle", "authorization": "ABC", "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
| Pflichtfeld
|
---|---|---|---|---|
| String | Der Typ der Daten, hier immer |
| |
| String | ISO-Zeitstempel des Alarms |
| |
| String | Absender der Statusmeldung, steht dann als Quelle im Alarm | ||
| 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. |
| |
| String | Fahrzeugstatus |
| |
| String | Statustext | ||
| String | Fahrzeugkennung |
| |
| String | Funkrufname des Fahrzeugs |
| |
| double | Breitengrad des Einsatzmittels | ||
| double | Längengrad des Einsatzmittels | ||
| int | Höhe über NN des Einsatzmittels in Metern | ||
| int | Genauigkeit der Positionsangabe in Metern |
Das Es wird nur entweder |
Positionsmeldungen können ab Version übermittelt werden.
{ "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
| Pflichtfeld
|
---|---|---|---|---|
| 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. | ||
| String | Fahrzeugkennung |
| |
| double | Breitengrad |
| |
| double | Längengrad |
|
|
| long | Höhe über NN des Einsatzmittels in Metern | ||
| double | Richtung des Fahrzeugs |
Lagemeldungen können ab Version übermittelt werden.
{ "authorization": "1234", "externalId": "aaaa-bbbbb-ccccc", "message": "Nachricht", "messageId": "d1a15a6b971c", "senderId": "51f5e6a7b9", "senderName": "Leitstelle", "timestamp": "2022-10-01T12:00:00+02:00" } |
Feld | Typ | Beschreibung | Pflichtfeld
|
---|---|---|---|
| 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. | |
| String | Einsatznummer des Alarms, anhand derer die Lagekarte gewählt wird | |
| String | Lagemeldung | |
| String | Absender der Lagemeldung | |
| String | ID der Lagemeldung | |
| String | ID des Absenders | |
| String | ISO-Zeitstempel der Lagemeldung |