Gültig ab FE2 Version
Gültig ab FE2 Version 2.24
Mittels dieser Schnittstelle können Sie das Adressbuch innerhalb von FE2 synchronisieren |
Die automatische Synchronisation ist in der FE2 Organisation aktiviert
Die Organisation hat ein ausreichendes Personenkontingent zugewiesen
POST http(s)://[FE2]:[PORT]/rest/addressbook/sync |
Der Zugriffschlüssel (zu finden in den Einstellungen der Organisation) muss als Authorization
Header übermittelt werden.
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 source
Parameter sollte ein lesbarer Name der Quelle angegeben werden. Das Feld externalDbId
enthält die Quell-Datenbank-ID der Person. Diese muss eindeutig sein und darf sich nie ändern.
{ "source": "Name des Drittanbieters", "personList": [ { "externalDbId": "123456", "firstName": "Max", "lastName": "Mustermann", "note": "Das ist eine Notiz", "osFunctions": [ "AGT", "MA" ], "osGroups": [ "Löschgruppe 1" ], "alarmGroups":[ "Alarm Gruppe", "Alarm Gruppe 2" ], "issi": "", "xmpp": "", "aPagerPro": "max.mustermann@example.com", "email": "max.mustermann@example.com", "mobil": "0049151123456", "aPagerProFieldMode": "LEGACY" } ] } |
Feld | Erklärung | FE2 Version | |
---|---|---|---|
| Hier muss die aPager PRO registrierte Adresse stehen. Dies kann eine E-Mail oder Handynummer sein. Bei Verwendung der neuen Tokens muss das Feld leer bleiben.
|
| |
|
|
| |
|
|
|
Beim Anlegen einer Person wird automatisch ein Token erstellt, wenn der gewählte Modus TOKEN
ist. Dieser kann nie wieder im Sync geändert werden.
Return-Code | |
---|---|
200 | Synchronisation erfolgreich |
401 | Falscher oder ungültiger Zugriffschlüssel übergeben |
403 | Kontingent für Personen der Organisation ist nicht ausreichend |
412 | Es wurde versucht eine Person zu synchronisieren, welche einer anderen Organisation angehören |
503 | Organisation hat die Synchronisation nicht aktiv |
API - Alarmierung von Personen
API - Zugriff auf Positionen von Personen