Herunterladen Diese Seite drucken

Pilz PITreader REST API Bedienungsanleitung Seite 69

Werbung

HTTP-Endpunkte des PITreaders
5.7
Informationen zum aktuellen Benutzer
5.7.1
HTTP-Endpunkt /api/me (GET)
Über den HTTP-Endpunkt /api/me können mit GET Informationen über den aktuell ange-
meldeten Benutzer ausgelesen werden.
Request
}
Schematische Darstellung
GET https://<IP-Adresse>:<Port-Nummer>/api/me
}
Parameter
Keine
}
Beispiel
GET https://192.168.0.12:443/api/me
Response
}
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
id
name
level
type
Response bei einem fehlerhaften oder unerlaubten Request
Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x
1005365-DE-05
Datentyp
NUMBER
STRING
NUMBER
NUMBER
INFO
Bei einem fehlerhaften oder unerlaubten Request enthält die Antwort im Re-
sponse-Header einen entsprechenden HTTP-Status Code. Die Antwort ent-
hält in diesen Fällen keine Request-spezifischen Datenfelder im Body. Sie
finden weitere Informationen unter
Bedeutung
ID des aktuell angemeldeten Benutzers
Name des aktuell angemeldeten Benutzers
Zugriffsberechtigung (Rolle) des aktuell an-
gemeldeten Benutzers
Benutzertyp
mögliche Inhalte:
1
Benutzer
2
API-Client
Response-Format [
12].
| 69

Werbung

loading

Diese Anleitung auch für:

Pitreader firmware v1.5.x