Herunterladen Diese Seite drucken

Pilz PITreader REST API Bedienungsanleitung Seite 57

Werbung

HTTP-Endpunkte des PITreaders
5.4.9
HTTP-Endpunkt /api/transponder/userData/clearGroup (POST)
Über den HTTP-Endpunkt /api/transponder/userData/clearGroup können mit POST im Ar-
beitsspeicher eines PITreaders die Parameterdaten für eine einzelne Gerätegruppe ge-
löscht werden.
Request
}
Schematische Darstellung
POST https://<IP-Adresse>:<Port-Nummer>/api/transponder/userData/clearGroup
}
Parameter
Die Parameter müssen im JSON-Format im Body des Requests übergeben werden.
deviceGroup <Nummer>
Hinweis: Dieses Datenfeld ist optional. Wenn es weggelassen wird, werden die
"Default-Werte" gelöscht.
}
Beispiel
POST https://192.168.0.12/api/transponder/userData/clearGroup
{
}
Response
Sie finden generelle Informationen unter
Bei einem Request mit POST besteht der Response-Body ausschließlich aus den generi-
schen Datenfeldern.
Response bei HTTP-Status Code 200
Sie finden Informationen zu den generischen Datenfeldern bei einem fehlerfreien Request
unter
Response bei einem fehlerhaften oder unerlaubten Request
Response bei einem fehlerhaften Request mit HTTP-Status Code 400
Abweichend vom dokumentierten Inhalt unter
400 [
enthalten.
Mögliche Inhalte des generischen Datenfelds "msg":
}
Fehlerursache: fehlerhafte Parameter
Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x
1005365-DE-05
"deviceGroup": 105
Response-Format bei HTTP-Status Code 200 [
INFO
Bei einem fehlerhaften oder unerlaubten Request enthält die Antwort im Re-
sponse-Header einen entsprechenden HTTP-Status Code. Sie finden weite-
re Informationen unter
13]
kann das generische Datenfeld "msg" genauere Angaben zur Fehlerursache
Gerätegruppe zu der der Parameter gehört
(Datentyp: NUMBER)
Nummer:
0 ... 9999
Response-Format [
Response-Format [
Response-Format bei HTTP-Status Code
12].
13].
12].
| 57

Werbung

loading

Diese Anleitung auch für:

Pitreader firmware v1.5.x