...
| Hinweis |
|---|
Diese Anleitung geht nur noch auf das Datenformat v2 ein. Frühere Formate (v1), werden nicht mehr unterstützt. |
Zugriff via HTTP POST
Datenübertragung via HTTP POST. Muss im Input-Plug-Plugin in aktiviert werden.
Zugriff mit
...
Datenformat
| Codeblock |
|---|
Für Alarme:
HTTP POST {IP}:{PORT}/rest/external/http |
Zugriff mit Datenmodell v2:
| Status | ||||
|---|---|---|---|---|
|
| Codeblock |
|---|
/alarm/v2 Für Statusmeldungen: HTTP POST {IP}:{PORT}/rest/external/http/status/v2 Für Positionsmeldungen: HTTP POST {IP}:{PORT}/rest/external/http/position/v2 Für Lagemeldungen: HTTP POST {IP}:{PORT}/rest/external/http/diary/v2 |
Parameter | Bedeutung |
|---|---|
IP | Die IP-Adresse des FE2 Systems oder localhost, falls der Zugriff über |
dasselbe System erfolgt | |
PORT | Der Port der FE2 Weboberfläche. Standard ist hier Port 83 |
Daten
UTF-8 kodiertes JSON als Body eines HTTP POST Aufrufs. Das Datenformat wird hier beschrieben.
Return-Werte
Es werden die Standard-HTTP-Return-Codes verwendet. Außerdem wird ein JSON Objekt zurück geliefertzurückgeliefert.
HTTP Code | Bedeutung |
|---|---|
200 | Alarm erfolgreich übergeben |
400 | Der Aufruf war fehlerhaft |
406 | Der Alarmeingang ist deaktiviert |
409 | Inhalt des Aufrufs steht in Konflikt mit Einstellungen/Voraussetzungen in FE2. |
Beispiel Return Objekt
| Codeblock |
|---|
{
"status":"OK|NOT_OK",
"error":"Error message"
} |
Als Body wird ein UTF-8 kodiertes JSON zurückgeliefert:
Feld | Bedeutung |
|---|---|
|
|
| Sollte Status NOT_OK sein, wird hier der Fehler näher beschreiben |
Zugriff via HTTP GET
Datenübertragung via HTTP GET. Muss im Input-Plug-Plugin in aktiviert werden.
| Warnung |
|---|
WarnungBei dieser Variante wird der Absender nicht überprüft! Sie sollten diese Schnittstelle also nur in lokalen Netzwerken erlauben, welche Sie unter Ihrer Kontrolle haben. |
...
| Codeblock |
|---|
HTTP GET {IP}:{PORT}/rest/external/http?message=Text¶m1=value1¶m2=value2 |
Parameter | Bedeutung |
|---|---|
IP | Die IP-Adresse des FE2 Systems oder localhost, falls der Zugriff über |
dasselbe System erfolgt | |
PORT | Der Port der FE2 Weboberfläche. Standard ist hier Port 83 |
message | Der einzige Parameter, welcher vorgeschrieben ist. Dies ist der Alarmtext |
Daten
Alle Daten können via URL Parameter im Format key=value übergeben werden. Welche URL Parameter beachtet werden, definieren Sie im Alarmeingang unter GET Parameter in folgendem Format:
| Codeblock |
|---|
QueryParameter;FE2Parameter |
Feld | Bedeutung |
|---|---|
QueryParameter | Geben Sie hier an, wie der entsprechende Query Parameter heißt |
FE2Parameter | Unter diesem Parameter wird dann der entsprechende Wert gespeichert. Verwendung von messageMessage wird innerhalb der URL immer als Pflichtparameter erwartet. Verwendung von addressSollten Sie hier address angeben, wird der QueryParameter als Feld address alarmiert, wodurch spezifische Einheiten direkt alarmiert werden können |
Beispiel für Definition Parameter im Alarmeingang
...
Es werden die Standard-HTTP-Return-Codes verwendet.
HTTP Code | Bedeutung |
|---|---|
200 | Alarm erfolgreich übergeben |
400 | Der Aufruf war fehlerhaft |
Als Body wird ein einfaches OK oder NOK zurückgeliefert.