API - Abrufen von Rückmeldungen alarmierter Personen
- Svenja Stöber
Gültig ab FE2 Version 2.34
Mittels dieser Schnittstelle können Sie Rückmeldungen von Personen einer Alarmierung direkt via URL-Aufruf anfragen.
Voraussetzungen
Die automatische Synchronisation ist in der FE2 Organisation aktiviert
Die Alarmierung für Personen ist in der FE2 Organisation aktiviert
Kann nur für Organisation mit Online-Service genutzt werden
zuvor muss eine Alarmierung mit Rückmeldung über https://alamos-support.atlassian.net/wiki/x/EYALjw ausgelöst haben
Rückmeldungen von Personen einen Alarmierung
Mit diesem Aufruf können Sie Rückmeldungen von Personen, welche zuvor überhttps://alamos-support.atlassian.net/wiki/x/EYALjw alarmiert wurden, abrufen.
Aktualisierungen der Rückmeldungen sind nicht in Echtzeit abrufbar. Vollständige Rückmeldedaten sind ggf. erst zu einen späteren Zeitpunkt verfügbar.
Aufruf
GET http(s)://[FE2]:[PORT]/rest/addressbook/external/{alarmId}/feedbackFür den Abruf der Rückmeldungen muss die ID der Alarmierung im Pfad gesetzt werden. Diese kann bei der Alarmierung im Parameter externalIdangegeben werden. Ohne den Wert können Rückmeldungen nicht über FE2 abgerufen werden
Request-Headers
Folgende Header müssen in der Anfrage gesetzt werden:
Header | Wert |
|---|---|
Authorization | Zugriffsschlüssel der Organisation |
Content-Type | application/json |
Datenformat
Die Rückmeldedaten werden im JSON-Datenformat zurück gegeben. Als Antwort sind die folgenden Felder enthalten.
[
{
"externalPersonId": "123456",
"name": "Mustermann Max",
"groups": [
"Löschgruppe 1",
"Löschgruppe 2"
],
"free": null,
"functions": [
"AGT",
"MA"
],
"state": "NO",
"timeOfUpdate": "2024-05-21T15:46:24.54+02:00"
},
{
"externalPersonId": "789101",
"name": "Mustermann Berta",
"groups": [
"Löschgruppe 1"
],
"free": null,
"functions": [
"AGT"
],
"state": "YES",
"timeOfUpdate": "2024-05-21T15:47:24.54+02:00"
}
]Datenfelder
Feld | Bedeutung |
|---|---|
| ID der synchronisierten Person |
| Name gesetzte Name der Person |
| String-Liste der an der Person definierten Gruppen, ggf. eine leere Liste |
| String-Liste der an der Person definierten Funktionen, ggf. eine leere Liste |
| Text der Rückmeldung (wenn eigener Rückmeldetext definiert wurde, andernfalls null) |
| Rückmeldewert. Hier sind die folgenden Werte möglich YES, // Zusage
READ, // Alarmierung wurde nur bestätigt
NO, // Absage
FREE, // Freitext
HERE,
ABSENT,
RECEIVED |
| Zeitpunkt der Rückmeldung (Format nach ISO-8601) |
Â
Return-Codes
Return-Code | Â |
|---|---|
200 | Wenn Abruf der Rückmeldedaten erfolgreich durchgeführt werden konnte |
401 | Falscher oder ungültiger Zugriffsschlüssel übergeben. |
404 | Wenn keine Rückmeldungen für eine Alarmierung gefunden wurde |
429 | maximale Anzahl der Anfragen für Intervall überschritten. Das Limit beträgt 60 Anfragen pro Minute |
500 | Wenn Antwort nicht geschrieben werden konnte |
503 | Organisation hat die Synchronisation und Personenalarm nicht aktiv |