API - Alarmierung von Personen
- Simon Scherer
- Svenja Stöber
- Merlin Pfeifer
Gültig ab FE2 Version 2.26
Mittels dieser Schnittstelle können Sie im FE2-Adressbuch hinterlegte Personen direkt via URL-Aufruf alarmieren.
- 1.1 Voraussetzungen
- 2 Alarmierung von einzelnen Personen
- 2.1 Aufruf
- 2.2 Request-Headers
- 2.3 Datenformat
- 2.3.1 Datenfelder
- 2.4 Return-Codes
- 3 Alarmierung von mehreren Personen gleichzeitig
- 3.1 Aufruf
- 3.2 Request-Headers
- 3.3 Datenformat
- 3.4 Return-Codes
- 4 Abruf von Personen
- 4.1 Aufruf
- 4.2 Request-Headers
- 4.3 Rückgabewert
Voraussetzungen
Die automatische Synchronisation ist in der FE2 Organisation aktiviert
Die Alarmierung für Personen ist in der FE2 Organisation aktiviert
Alarmierung von einzelnen Personen
Mit diesem Aufruf können Sie eine einzelne Person alarmieren.
Aufruf
POST http(s)://[FE2]:[PORT]/rest/addressbook/external/person/{id}/alarmFür die Alarmierung muss die id gesetzt werden. Diese kann der externalDbId oder der ID der Person von FE2 entsprechen.
Request-Headers
Folgende Header müssen in der Anfrage gesetzt werden:
Header | Wert |
|---|---|
Authorization | Zugriffsschlüssel der Organisation |
Content-Type | application/json |
Datenformat
Als Datenformat kommt JSON zum Einsatz. Im Feld type kann die Art der Nachricht gewählt werden. Hier sind die Werte ALARM oder INFO zulässig. Mit den Typ INFO wird ein Info-Alarm bei der Person ausgelöst. Optional können Farbe (color) für die Anzeige der Nachricht in aPager und die Koordinaten (lat und lng) gesetzt werden.
{
"type": "ALARM",
"title": "Titel der Nachricht",
"color": "#FE2E2E",
"message": "Textinhalt der Nachricht",
"group": "Alarmgruppenname",
"lat": 48.35512,
"lng": 10.903633,
"withFeedback": false,
"externalId": "68bcca1d-3dc9-403f-94c5-b17679af6aef",
"customFeedbackName":"Meine Rückmeldeoptionen",
"expiresHours": 24
}Datenfelder
Feld | Bedeutung | Pflichtfeld |
|---|---|---|
| Typ der Nachricht (ALARM, INFO) | Ja |
| Titel der Nachricht | Ja |
| Farbe der Nachricht | Ja |
| Inhalt | Ja |
| Einheitenkennung | Ja |
| Koordinaten des Einsatzortes | Ja |
| Ja | |
| Ob der Alarm Rückmeldungen enthalten soll | Nein |
| Anzahl in Stunden, bis der Alarm automatisch aus aPager PRO gelöscht wird | Nein |
Rückmeldungen funktionieren nur in Organisationen, welche einen aktiven Online-Service haben.
Return-Codes
Return-Code |
|
|---|---|
200 | Alarmierung der Person erfolgreich |
400 | Das Mappen des JSON ist fehlgeschlagen |
401 | Falscher oder ungültiger Zugriffsschlüssel oder Personen ID übergeben. |
403 2.32 | Wenn eine synchronisierte Person in FE2 blockiert wurde |
404 | keine Person zur Alarmierung gefunden. |
429 | maximale Anzahl der Anfragen für Intervall überschritten. Das Limit beträgt 60 Anfragen pro Minute |
503 | Organisation hat die Synchronisation und Personenalarm nicht aktiv |
Alarmierung von mehreren Personen gleichzeitig
Mit diesem Aufruf können Sie mehrere Personen gleichzeitig alarmieren (Ab Version 2.29)
Aufruf
POST http(s)://[FE2]:[PORT]/rest/addressbook/external/person/alarmFür die Alarmierung muss die id gesetzt werden. Diese kann der externalDbId oder der ID der Person von FE2 entsprechen.
Request-Headers
Folgende Header müssen in der Anfrage gesetzt werden:
Header | Wert |
|---|---|
Authorization | Zugriffsschlüssel der Organisation |
Content-Type | application/json |
Datenformat
Als Datenformat kommt JSON zum Einsatz. Im Feld type kann die Art der Nachricht gewählt werden. Hier sind die Werte ALARM oder INFO zulässig. Mit den Typ INFO wird ein Info-Alarm bei der Person ausgelöst. Optional können Farbe (color) für die Anzeige der Nachricht in aPager und die Koordinaten (lat und lng) gesetzt werden.
Die Liste der Personen wird hierbei als Liste von IDs direkt im Request mit übermittelt.
Return-Codes
Return-Code |
|
|---|---|
200 | Alarmierung der Person erfolgreich |
400 | Das Mappen des JSON ist fehlgeschlagen |
401 | Falscher oder ungültiger Zugriffsschlüssel oder Personen ID übergeben. |
403 2.32 | Wenn eine synchronisierte Person in FE2 blockiert wurde |
404 | keine Person zur Alarmierung gefunden. |
429 | maximale Anzahl der Anfragen für Intervall überschritten. Das Limit beträgt 60 Anfragen pro Minute |
503 | Organisation hat die Synchronisation und Personenalarm nicht aktiv |
Abruf von Personen
Damit Sie Personen anhand derer ID alarmieren können, müssen Sie diese zuerst kennen. Über diese Schnittstelle können Sie alle Personen abrufen und erhalten die ID für die Alarmierung. (Ab Version 2.27)
Aufruf
Request-Headers
Folgende Header müssen in der Anfrage gesetzt werden:
Header | Wert |
|---|---|
Authorization | Zugriffsschlüssel der Organisation |
Content-Type | application/json |
Rückgabewert
Als Datenformat kommt JSON zum Einsatz. Sie erhalten eine Liste von allen Personen, deren Namen und internen und ggf. externen IDs.