Pilz PITreader REST API Bedienungsanleitung Seite 16

HTTP-Endpunkte des PITreaders
5 HTTP-Endpunkte des PITreaders
5.1 Allgemeine Geräteinformationen
5.1.1 HTTP-Endpunkt /api/status (GET)
Über den HTTP-Endpunkt /api/status können mit GET aktuelle Statusinformation zum Zu-
stand und zu den Eigenschaften des Gerätes ausgelesen werden.
Request
}
Schematische Darstellung
GET https://<IP-Adresse>:<Port-Nummer>/api/status
}
Parameter
Keine
}
Beispiel
GET https://192.168.0.12:443/api/status
Response
Sie finden generelle Informationen unter
}
Request-spezifische Datenfelder im Body bei
– erfolgreicher Authentifizierung
– HTTP-Status Code 200
Die Antwort enthält im Body die folgenden Request-spezifischen Datenfelder und Inhalte
im JSON-Format:
Feldname
hostName
ipAddress
orderNo
productType
serialNo
macAddress
seuStatus
Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x
1005365-DE-05
Response-Format [
Datentyp Bedeutung
STRING Hostname/Name des Gerätes
STRING IP-Adresse des Gerätes
STRING Bestellnummer des Gerätes
STRING Produktname des Gerätes
NUMBER Seriennummer des Gerätes
STRING MAC-Adresse des Gerätes
Format: 00:00:00:00:00:00
BOOLEAN Status der Verbindung zwischen PIT m4SEU
und PITreader
Möglicher Inhalt:
true
false
12].
Es besteht eine aktive Verbindung
zwischen einem PIT m4SEU und
dem PITreader.
Es besteht keine Verbindung zwi-
schen einem PIT m4SEU und dem
PITreader.
| 16