API - Zugriff auf Positionen von Personen
- Svenja Stöber
- Simon Wheeler
- Simon Scherer
Mittels dieser Schnittstelle können Sie das Adressbuch innerhalb von FE2 synchronisieren
- 1 Voraussetzungen
- 1.1 Aufruf
- 1.2 Request-Headers
- 1.3 Datenformat
- 1.4 Return-Codes
Voraussetzungen
Die automatische Synchronisation ist in der FE2 Organisation aktiviert
Die Abfrage von Positionen für Personen ist in der FE2 Organisation aktiviert
Es ist eine Lizenz für den Zugriff auf Standorte vorhanden
Aufruf
GET http(s)://[FE2]:[PORT]/rest/addressbook/external/tracking/person/[id]Für den Zugriff auf die Position einer Person muss die id gesetzt werden. Diese kann der externalDbId oder der ID der Person von FE2 entsprechen.
Request-Headers
Folgende Header müssen in der Anfrage gesetzt werden:
Header | Wert |
|---|---|
Authorization | Zugriffsschlüssel der Organisation |
Datenformat
Ist die Anfrage erfolgreich, werden die Daten im JSON-Format übermittelt. Dieses JSON weißt folgendes Format auf:
{
"personId": "xxxx-xxx",
"externalPersonId": "xxxx-xxxx-xxxx"
"timestamp": "1641295139",
"accuracy": 34,
"lat": 48.35512,
"lng": 10.903633
}Return-Codes
Return-Code |
|
|---|---|
200 | Positionsabfrage der Person erfolgreich. Body enthält Daten im oben beschriebenen Format. |
400 | Benötigte Daten (Authorization Header oder Personen ID) wurde nicht richtig gesetzt |
401 | Falscher oder ungültiger Zugriffschlüssel oder Personen ID übergeben. Wird auch zurückgegeben wenn Person keinen vollen Zugriff auf Position zulässt. |
404 | Es wurde keine Person zur Positionsabfrage gefunden. |
500 | Benötigte Daten konnten nicht abgefragt werden, durch einen internen Fehler. |
503 | Organisation hat die Synchronisation und Zugriff auf Personen nicht aktiv oder es ist die Einsicht auf Personenstandorte nicht lizensiert. |