Die folgenden Informationen beziehen sich auf Versionen ab 1.20 des webservice_SmartGate.

Um zu erkennen ob es bei der Ausführung des Requests einen Fehler gab, prüft man auf das Vorhandensein eines Elementes „ErrorResponse“ im Body der Rückgabe (Ausnahme bei engine-Methoden beachten, s. nächster Abschnitt). Liefert der folgende XPath Ausdruck ein Ergebnis gab es einen Fehler:

//ErrorResponse

Die Fehlermeldungen sind abhängig davon ob der Fehler vor oder nach dem Beginn der Auslieferung des Ergebnisses (dem „Streaming“) aufgetreten ist an den folgenden Stellen zu finden (Beispiele siehe weiter unten):

• Fall 1: Einzelne Meldung direkt zum ErrorResponse-Element (vor dem Beginn des Streamings), XPath-Ausdruck:

  //ErrorResponse/text()

• Fall 2: Eine oder mehrere Meldungen unterhalb der Errors-Elemente, XPath-Ausdruck:

  //ErrorResponse/Response/Errors/Error/Message

Kommt es bei der Methode engine/execute bzw. engine/<Prozedurname> zu einem Fehler, ist dies i.d.R. an einem Element „ErrorCode“ als Nachfolger des fehlgeschlagenen „Statement“ zu erkennen. Da es aber bestimmte Fehler gibt (z.B. die Prozedur ist nicht vorhanden oder kann erst gar nicht ausgeführt werden), bei denen kein „ErrorCode“ geliefert werden kann, ist auf jeden Fall zusätzlich auf ein „ErrorResponse“-Element (wie im vorherigen Abschnitt beschrieben) zu prüfen. Das Attribut „Code“ liefert den Fehler-Code und im Element „Messages“ befindet sich eine Klartext-Fehlermeldung.

Der XPath-Ausdruck zur Ermittlung des Fehlercodes (und damit implizit ob ein Fehler aufgetreten ist) lautet:

//Statement/ErrorCode[@Code != 0]/Code

Die Meldungen können über folgenden XPath-Ausdruck aus dem XML extrahiert werden:

//Statement/Messages/Message/text()

Der HTTP-Status-Code alleine eignet sich nicht zur Auswertung ob der Request erfolgreich ausgeführt wurde. Der Status-Code wird zwar so oft wie möglich gesetzt, jedoch unterstützt das webservice_SmartGate ein Streaming von Ergebnissen via chunked transfer encoding. Kommt es also zu einem Fehler nachdem bereits Daten (und damit der Response-Header) an den Client geschickt wurden ist der Status-Code 200, es existiert aber ein ErrorResponse-Element.

Im folgenden provozieren wir mal einige typische Fehlerszenarien:

Weitere häufige Fehler die nicht durch „klickbare“ Beispiele zu provozieren sind:

• RequestRateToHigh - Rate der Abfragen

In der Methode item/get wurden mit dem webservice_SmartGate Version 1.23 folgende Fehlercodes eingeführt um bestimmte Fehlersituationen gesondert zu behandeln: