API

• Definition
  • Beispiel

Definition

Achtung: Da die genaue Funktionsweise der neuen GETS-Zentrale noch nicht bekannt ist, wird sich die Schnittstelle für diese API mit höchster Wahrscheinlichkeit noch ändern. Das allgemeine Funktionsprinzip wird jedoch beibehalten.

Ziel der API ist es, Fremdsystemen zu ermöglichen, Daten an die CareSuite zu senden.

Primär wird diese Funktion genutzt um Rufe und Anwesenheiten auf VisiCall-Bildschirmen anzuzeigen. Weiter können Positionsangaben oder Batteriestände von Elementen aktualisiert werden.

Diese Informationen werden per einfachem HTTP-Request an die CareSuite gesendet.

Als Endpunkt für alle API-Anfragen gilt die Basis-URL http://<caresuite>/api/v1. <caresuite> entspricht dem unter Integration → Konfigurationswerte → URL des API-Servers hinterlegten Wert.

Beispiel

Positionsupdate

1. Ein Funkelement überquert den Checkpoint Haupteingang
2. Ein HTTP-Request mit der neuen Position wird an http://caresuite/v1/api/carecall versendet
3. Die neue Position des Elements wird in der CareSuite registriert

Flucht

1. Ein Funkelement überquert unerlaubt den Checkpoint Haupteingang
2. Ein HTTP-Request mit der Fluchtmeldung wird an http://caresuite/v1/api/visicall versendet
3. Der Flucht-Ruf erscheint auf allen VisiCall-Bildschirmen