API - Automatische Synchronisation des FE2 Adressbuches
Gültig ab FE2 Version 2.24
Mittels dieser Schnittstelle können Sie das Adressbuch innerhalb von FE2 synchronisieren
Voraussetzungen
Die automatische Synchronisation ist in der FE2 Organisation aktiviert
Die Organisation hat ein ausreichendes Personenkontingent zugewiesen
Aufruf
POST http(s)://[FE2]:[PORT]/rest/addressbook/syncAuthentifizierung
Der Zugriffschlüssel (zu finden in den Einstellungen der Organisation) muss als Authorization Header übermittelt werden.
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 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"
}
]
}Besonderheiten
Die Synchronisationslogik betrifft nur Personen, die auch bereits einmal synchronisiert wurden. Das bedeutet:
nur Personen, die bereits synchronisiert wurden (d.h. wenn sie aus einer vorherigen Synchronisation stammen), wären betroffen und würden gelöscht werden
manuell (in FE2) erstellte Personen werden nicht gelöscht
Feld | Erklärung | FE2 Version |
|---|---|---|
| Übermitteln Sie hier alle Personen, die Sie nach FE2 synchronisieren wollen. Personen, die in der Liste nicht übermittelt werden, werden in FE2 gelöscht bzw. als gelöscht markiert (siehe Hinweis unter Löschen von Personen) |
|
| 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. Die Handynummer muss im Format 0049xxxxxxxxx sein. Andere Formate werden nicht unterstützt | 2.23 |
|
| 2.29 |
|
| 2.29 |
Hinweis zur Verwendung von aPager PRO Tokens
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-Codes
Return-Code |
|
|---|---|
200 | Synchronisation erfolgreich |
401 | Falscher oder ungültiger Zugriffschlüssel übergeben |
403 2.29 | Kontingent für Personen der Organisation ist nicht ausreichend |
412 2.29 | Es wurde versucht eine Person zu synchronisieren, welche einer anderen Organisation angehören |
423 2.39 | Die angefragte Synchronisation konnte auch nach 60 Sekunden nicht begonnen werden, da im Hintergrund bereits eine andere Synchronisation läuft - es wurden keine Änderungen durchgeführt, bitte später erneut probieren. |
503 | Organisation hat die Synchronisation nicht aktiv |
Löschen von Personen
Personen können ab FE2 2.36 auch gelöscht werden. Hierfür muss an den Synchronisations-Einstellungen in der Organisation der Haken Person löschen erlauben aktiviert sein.
Dieser Aufruf ist nicht notwendig, wenn eine volle Synchronisation gemacht wird. Bei der Synchronisation (siehe oben) werden Personen, die nicht mehr im Datensatz vorhanden sind, ebenfalls gelöscht bzw. als gelöscht markiert (abhängig von der Option Person löschen erlauben)
Aufruf
DELETE http(s)://[FE2]:[PORT]/rest/addressbook/external/persons/{externalDbId}Request-Headers und Parameters
Folgende Header müssen in der Anfrage gesetzt werden:
Header | Wert |
|---|---|
Authorization | Zugriffsschlüssel der Organisation |
| Die externe ID dieser Person, so wie diese bei der Synchronisation übergeben wurde |
Rufen Sie diese Schnittstelle nicht zeitgleich mit der Synchronisationsschnittstelle auf, da dies zu unvorhergesehenem Verhalten führen kann. Rufen Sie wenn notwendig zuerst die Löschen-Schnittstelle auf und nach erfolgreicher Ausführung die Synchronisationsschnittstelle.