Werbung
HTTP-Endpunkte des PITreaders
5.1.5
HTTP-Endpunkt /api/config/coding (POST)
Über den HTTP-Endpunkt /api/config/coding kann mit POST die Basis-Codierung eines
Geräts festgelegt werden.
Request
}
Schematische Darstellung
POST https://<IP-Adresse>:<Port-Nummer>/api/config/coding
}
Parameter
Die Parameter müssen im JSON-Format im Body des Requests übergeben werden.
comment <Kommentar>
identifier <Basis-ID>
Hinweis: Es muss mindestens einer der Parameter übergeben werden. Die Basis-
Kennung muss nicht zwingend übergeben werden, wenn ausschließlich ein Kommen-
tar zur Basis-Kennung hinterlegt oder der Kommentar geändert werden soll.
}
Beispiel
POST https://192.168.0.12/api/config/coding
{
}
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
Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x
1005365-DE-05
"identifier": "Secret Coding ID 123",
"comment": "My coding #1"
Response-Format bei HTTP-Status Code 200 [
Kommentar zur Basis-Kennung
(Datentyp STRING)
}
Anzahl der Zeichen [Byte]: 0 ... 63
}
gültige UTF8-Zeichen
}
Die Eingabe von UTF8-Zeichen, die mehr als 1
Byte benötigen, verringert die maximal erlaubte
Zeichenanzahl von 63 Zeichen.
Basis-Kennung
(Datentyp STRING)
}
Anzahl der Zeichen [Byte]: 0 ... 63
}
gültige UTF8-Zeichen
}
Die Eingabe von UTF8-Zeichen, die mehr als 1
Byte benötigen, verringert die maximal erlaubte
Zeichenanzahl von 63 Zeichen.
Response-Format [
13].
12].
| 26
Werbung
