Anfragen und Antworten

Werten Sie HTTP-Status, typisierte JSON-Daten und Anfragemetadaten gemeinsam aus.

Anfrage

Content-Type: application/json: Senden Sie JSON-Schreibvorgänge mit Content-Type: application/json.
data · meta: Erfolgreiche Antworten enthalten data und meta; Sammlungsantworten beschreiben außerdem die Paginierung.
error.code · error.message: Fehler enthalten error.code, error.message und gegebenenfalls Feldinformationen.

Erforderlichkeit und null-Zulässigkeit sind unabhängig.
Ein Pflichtfeld darf null enthalten, wenn sein Schema dies erlaubt.
Behalten Sie boolesche Werte, Ganzzahlen, Zeichenfolgen und null ohne Typumwandlung bei.
Geldbeträge sind Dezimalzeichenfolgen; berechnen Sie Preise nicht mit binären Gleitkommazahlen.

Einige Versionswerte sind vorzeichenbehaftete 64-Bit-Ganzzahlen.
JavaScript-Clients müssen JSON-Werte oberhalb von Number.MAX_SAFE_INTEGER verlustfrei verarbeiten und die ursprüngliche Ganzzahldarstellung senden.
Versionen weder runden noch in JSON-Zeichenfolgen umwandeln.

Cache-ControlZeichenfolgeOptional: Regeln für das Zwischenspeichern der Antwort.

const: "no-store"
X-Correlation-IDZeichenfolgeOptional: Kennung zur Nachverfolgung dieser HTTP-Anfrage.
WWW-AuthenticateZeichenfolgeOptional: Vom Server verlangtes Authentifizierungsschema.
AllowZeichenfolgeOptional: Von dieser Ressource unterstützte HTTP-Methoden.
Retry-AfterGanzzahlOptional: Mindestwartezeit vor einem erneuten Versuch in Sekunden.

minimum: 0
LocationZeichenfolgeOptional: Relativer URL der erstellten Ressource.