Dieser Artikel ist gültig ab Version
| Status | ||||
|---|---|---|---|---|
|
| 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 |
|---|
HTTP POST {IP}:{PORT}/rest/external/http |
Zugriff mit Datenformat v2:
| Status | ||||
|---|---|---|---|---|
|
| Codeblock |
|---|
HTTP POST {IP}:{PORT}/rest/external/http/v2 |
...
...
| colour | Green |
|---|---|
| title | 2.27 |
...
| Codeblock |
|---|
Für Alarme:
HTTP POST {IP}:{PORT}/rest/external/http/alarm/v2
Für Statusmeldungen:
HTTP POST {IP}:{PORT}/rest/external/http/status/v2 |
Der oben erwähnte Endpunkt /rest/external/http/v2 existiert weiterhin, jedoch wird empfohlen, /rest/external/http/alarm/v2 für Alarme zu nutzen.
Positionsmeldungen
| Status | ||||
|---|---|---|---|---|
|
| Codeblock |
|---|
Für Positionsmeldungen:
HTTP POST {IP}:{PORT}/rest/external/http/position |
Parameter | Bedeutung |
|---|---|
IP | Die IP-Adresse des FE2 Systems oder localhost, falls der Zugriff über das selbe 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 |
409 | Inhalt des Aufrufs steht in Konflikt mit Einstellungen/Voraussetzungen in FE2. |
...
Als Body wird ein UTF-8 kodiertes JSON zurückgeliefert:
Feld | Bedeutung |
|---|---|
|
|
| Sollte Status NOT_OK sein, wird hier der Fehler näher beschreiben |
...
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. |
...
Parameter | Bedeutung |
|---|---|
IP | Die IP-Adresse des FE2 Systems oder localhost, falls der Zugriff über das selbe 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 |
...