Werbung
Funktionsbeschreibung
4.3
Response-Format
Auf einen Request des Clients schickt der Webserver eine Antwort (Response) im JSON-
Format.
Die Antwort besteht immer aus dem Response-Header, der unter Anderem den HTTP-Sta-
tus Code und das Response-Feld "Content-Type" enthält.
Auf den Response-Header folgt der Body.
Bei einem Request mit GET besteht der Body aus den generischen Response-Datenfel-
dern und bei einem fehlerfreien Request zusätzlich aus den Request-spezifischen Respon-
se-Datenfeldern.
Bei einem Request mit POST besteht der Body ausschließlich aus den generischen Re-
sponse-Datenfeldern.
Prinzipieller Aufbau der Antwort
Response-Header
Status Code
Content Type
<...>
Generische Response-Datenfelder
msg
data
success
Request-spezifische Response-Datenfelder
Die Request-spezifischen Response-Datenfelder sind ausschließlich in einer Antwort auf
einen fehlerfreien Request mit GET vorhanden; d. h.:
}
Response auf einen Request mit HTTP-Methode GET
}
Response Header = HTTP-Status Code 200
<...>
Aufbau und Inhalt einer Antwort in Abhängigkeit vom HTTP-Status Code
Sie finden Informationen zu den verschiedenen Response-Formaten in den folgenden Ab-
schnitten:
}
Fehlerfreier Request: siehe
}
Fehlerhafter Request: siehe
}
Unerlaubter Request: siehe
}
Interner Fehler: siehe
Bedienungsanleitung PITreader REST API, PITreader Firmware V1.5.x
1005365-DE-05
Response-Format bei HTTP-Status Code 200 [
Response-Format bei HTTP-Status Code 400 [
Response-Format bei HTTP-Status Code 403 [
Response-Format bei HTTP-Status Code 500 [
<HTTP-Status Code>
Sie finden weitere Informationen unter
HTTP-Status Codes [
immer: application/json
<...>
"" (leerer String)
Hinweis:
Abhängig vom Request mit POST kann
der Inhalt abweichen.
null
<Inhalt abhängig vom Status Code>
<...>
73].
13]
13]
14]
14]
| 12
Werbung
