Herunterladen Diese Seite drucken

Pilz PITreader REST API Bedienungsanleitung Seite 47

Werbung

HTTP-Endpunkte des PITreaders
5.4.4
HTTP-Endpunkt /api/config/userData/parameter (POST)
Über den HTTP-Endpunkt /api/config/userData/parameter kann ein einzelner Parameter
der Anwenderdaten-Konfiguration auf dem PITreader neu gesetzt oder geändert werden.
Hinweis: Die Übernahme von geänderten Parametern auf den Transponder muss über den
Endpunkt /transponder/userData/clear mit POST erfolgen.
Request
}
Schematische Darstellung
POST https://<IP-Adresse>:<Port-Nummer>/api/config/userData/parameter
}
Parameter
Die Parameter müssen im JSON-Format im Body des Requests übergeben werden.
id <Nummer>
name <Name>
type <Typ-ID>
size <Datenlänge>
Hinweis:
}
}
Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x
1005365-DE-05
Ist die übergebene Parameter-ID in der Anwenderdaten-Konfiguration noch nicht
vorhanden, so wird der Parameter in der Anwenderdaten-Konfiguration neu ange-
legt.
Ist die übergebene Parameter-ID bereits in der Anwenderdaten-Konfiguration vor-
handen, so wird der Parameter entsprechend aktualisiert.
Parameter-ID
(Datentyp: NUMBER)
Nummer: 1 ... 65535
Name des Parameters
(Datentyp: STRING)
Name: UTF-8 String mit 1 ... 63 Zeichen
Typ-ID (= ID des Datentyps)
(Datentyp: NUMBER)
Typ-ID: gültige Eingabe siehe [*1]
Maximale Zeichenanzahl für einen Parameter des Daten-
typs "STRING" (optional)
(Datentyp: NUMBER)
Datenlänge: 2 ... 255 (siehe [*1])
Hinweis: "size" muss ausschließlich bei einem Parameter
mit Typ-ID 1 (STRING) übergeben werden. Die Zeichen-
anzahl (Datenlänge in Byte) muss um 1 Byte größer ge-
wählt werden, als die gewünschte Zeichenanzahl;
d. h.:
size = <Zeichenanzahl in Byte> + 1 Byte (= Abschluss-
zeichen '\0')
size
<= 255
max
| 47

Werbung

loading

Diese Anleitung auch für:

Pitreader firmware v1.5.x