IApiResponseModel | @termingo/termingo-planner-api-ts

Beschreibt das Modell das ein Ergebnis eines REST-API-Aufrufs repräsentiert.

Alle API-Aufrufe liefern eine Variante dieses Typs zurück.

Hierarchy

IApiResponseModel

Index

Properties

correlationId

correlationId: string

Die interne Vorgangs-ID. Kann im Fehlerfall als Referenz für die Analyse der Logdateien verwendet werden.

Die API-Aufrufe können per ?correlation={correlation_id} eine Vorgangs-ID vorgeben.

Wichtig: Vorgangs-IDs sollten eindeutig sein und aus nicht mehr als 50 Zeichen bestehen. Die Verwendung nicht eindeutiger Vorgang-IDs kann zu unerwarteten Ergebnissen führen.

data

data: any

Die Ergebnisdaten als JSON-Objekt/-Variable.

In den meisten Fällen ist diese Eigenschaft nur bei einem erfolgreichen Request gesetzt. Im Fehlerfall kann diese Eigenschaft fehlen.

Optional errorCode

errorCode: number

Der API-Fehlercode.

Ist nur gesetzt, wenn ein kategorisierbarer Fehler aufgetreten ist.

Liste der allgemeinen Fehlercodes.

Optional errorMessage

errorMessage: string

Die Fehlermeldung der API.

Ist nur gesetzt, wenn ein Fehler beim Verarbeiten des Aufrufs aufgetreten ist.

Optional invalidFields

invalidFields: string[]

Die Auflistung der Namen der übermittelten Felder, deren Wert nicht gültig ist.

Ist nur gesetzt, wenn beim Verarbeiten des Aufrufs Validierungsfehler aufgetreten sind.

Optional invalidQueryArgs

invalidQueryArgs: string[]

Die Auflistung der übermittelten Query-Parameter, deren Name oder Wert nicht gültig ist.

Ist nur gesetzt, wenn beim Verarbeiten des Aufrufs Validierungsfehler aufgetreten sind.

Optional listOptions

listOptions: IListOptions

Die Optionen der Datensatzermittlung in Listenform.

Ist nur gesetzt, wenn das Ergebnis eine Liste von Datensätzen ist.

succeeded

succeeded: boolean

Ist gesetzt, wenn der Aufruf erfolgreich verarbeitet wurde.