Versionen im Vergleich

Alte Version 12

changes.mady.by.user Simon Wheeler

Gespeichert am

verglichen mit

Neue Version 13

changes.mady.by.user Simon Wheeler

Gespeichert am

Schlüssel

  • Diese Zeile wurde hinzugefügt.
  • Diese Zeile wurde entfernt.
  • Formatierung wurde geändert.

...

FE2

...

Dieser Artikel ist gültig ab Version

Status
colourGreen
title2.19

Zugriff via HTTP POST

Datenübertragung via HTTP POST. Muss im Input-Plugin aktiviert werden.

Zugriff

Codeblock
HTTP POST {IP}:{PORT}/rest/external/http

Parameter

Bedeutung

IP

Die IP Adresse des FE2 Systems oder localhost, falls der Zugriff über das selbe 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

Return-Werte

Es werden die Standard-HTTP-Return-Codes verwendet. Außerdem wird ein JSON Objekt zurück geliefert.

HTTP Code

Bedeutung

200

Alarm erfolgreich übergeben

400

Der Aufruf war fehlerhaft

...

...

Beispiel Return Objekt

Codeblock
{
  "status":"OK|NOT_OK",
  "error":"Error message"
}

Als Body wird ein UTF-8 kodiertes JSON zurückgeliefert:

Feld

Bedeutung

status

  • OK

    • Korrekte Annahme des Alarms

  • NOT_OK

    • Alarm Übergabe war fehlerhaft. Details im error Feld

error

Sollte Status NOT_OK sein, wird hier der Fehler näher beschreiben

Zugriff via HTTP GET

Datenübertragung via HTTP GET. Muss im Input-Plugin aktiviert werden.

Warnung
title

Warnung

Bei dieser Variante wird der Absender nicht überprüft! Sie sollten diese Schnittstelle also nur in lokalen Netzwerken erlauben, welche Sie unter Ihrer Kontrolle haben.

Zugriff

Codeblock
HTTP GET {IP}:{PORT}/rest/external/http?message=Text&param1=value1&param2=value2

Parameter

Bedeutung

IP

Die IP Adresse des FE2 Systems oder localhost, falls der Zugriff über das selbe 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

QueryParameter

FE2Parameter

Unter diesem Parameter wird dann der entsprechende Wert gespeichert.

Verwendung von message

Message wird innerhalb der URL immer als Pflichtparameter erwartet.

Verwendung von address

Sollten 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

Codeblock
Alarmtext;message
Liste;address
Straße;street

Return-Werte

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.