Gültig ab FE2 Version
Gültig ab FE2 Version 2.26
Mittels dieser Schnittstelle können Sie im FE2-Adressbuch hinterlegte Personen direkt via URL-Aufruf alarmieren. |
Die automatische Synchronisation ist in der FE2 Organisation aktiviert
Die Alarmierung für Personen ist in der FE2 Organisation aktiviert
Mit diesem Aufruf können Sie eine einzelne Person alarmieren.
POST http(s)://[FE2]:[PORT]/rest/addressbook/external/person/{id}/alarm |
Für die Alarmierung muss die id gesetzt werden. Diese kann der externalDbId
oder der ID der Person von FE2 entsprechen.
Folgende Header müssen in der Anfrage gesetzt werden:
Header | Wert |
---|---|
Authorization | Zugriffsschlüssel der Organisation |
Content-Type | application/json |
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 } |
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-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 | 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 |
Mit diesem Aufruf können Sie mehrere Personen gleichzeitig alarmieren (Ab Version )
POST http(s)://[FE2]:[PORT]/rest/addressbook/external/person/alarm |
Für die Alarmierung muss die id gesetzt werden. Diese kann der externalDbId
oder der ID der Person von FE2 entsprechen.
Folgende Header müssen in der Anfrage gesetzt werden:
Header | Wert |
---|---|
Authorization | Zugriffsschlüssel der Organisation |
Content-Type | application/json |
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.
{ "type": "ALARM", "title": "Titel der Nachricht", "color": "#FE2E2E", "message": "Textinhalt der Nachricht", "group": "Alarmgruppenname", "lat": 48.35512, "lng": 10.903633, "personIds":[ "1d196821-b24e-460e-8ac2-5de36b73ea76", "2422d3a5-c81d-4cbc-8f6b-858bf842bd45" ] } |
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 | 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 |
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 )
GET http(s)://[FE2]:[PORT]/rest/addressbook/external/persons |
Folgende Header müssen in der Anfrage gesetzt werden:
Header | Wert |
---|---|
Authorization | Zugriffsschlüssel der Organisation |
Content-Type | application/json |
Als Datenformat kommt JSON zum Einsatz. Sie erhalten eine Liste von allen Personen, deren Namen und internen und ggf. externen IDs.
[ { "personDbId": "adafc82e1141ab4d323796518f9a8151ff8de41a06595020a980b8", "displayName": "Nussbaum Nadine", "externalDbId": null } ] |