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

1 Voraussetzungen
2 Aufruf
3 Authentifizierung
4 Request-Headers
5 Datenformat
- 5.1 Besonderheiten
- 5.2 Hinweis zur Verwendung von aPager PRO Tokens
6 Return-Codes
7 Weitere Anfragen im Zusammenhang der Adressbuch Synchronisation

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/sync

Authentifizierung

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

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

Feld	Erklärung	FE2 Version

Feld	Erklärung	FE2 Version
`aPagerPro`	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
`aPagerProFieldMode`	`LEGACY` (default) Für die aPager PRO Registrierung soll eine E-Mail-Adresse oder Handynummer verwendet werden `TOKEN` Es soll ein aPager PRO Token für die Registrierung generiert werden `NO_APAGER` aPager PRO soll nicht verwendet werden	2.29
`keyOfProvisioningField`	Wird nur berücksichtigt, wenn ein aPager PRO Token verwendet wird `EMAIL` (default) Die aPager PRO Provisionierung soll als E-Mail verschickt werden (Feld `email` muss einen Wert enthalten) `MOBIL` Die aPager PRO Provisionierung soll als SMS verschickt werden (Feld `mobil` muss einen Wert enthalten)	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

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
503	Organisation hat die Synchronisation nicht aktiv

Weitere Anfragen im Zusammenhang der Adressbuch Synchronisation

API - Alarmierung von Personen

API - Zugriff auf Positionen von Personen