Response Type
Ein Element vom Typ vct:ResponseType besteht aus folgenden Elementen
Name | Typ/Vorkommen | Beschreibung |
|---|---|---|
vct:BuyersID | udt:IdentifierType | Kennzeichnung des Käufers, wie z.B. Kundennummer |
vct:ResponseCode | Informiert über Erfolg oder Mißerfolg der Operation, sowie über mögliche Fehlergründe | |
vct:ResponseMessage | xsd:string? | Optionale Erfolgs- oder Fehlermeldung im Klartext. |
vct:SellersID | udt:IdentifierType? | Kennzeichnung des Verkäufers, nur erforderlich, falls der Server für mehrere Verkäufer betrieben wird. |
vct:TransactionID | xsd:normalizedString? | Zur Identifikation der Transaktionsinstanz |
vct:StatusCode | Sofern die Operation innerhalb einer Transaktion durchgeführt wird: Zustand der Transaktion nach dieser Operation. | |
vct:IsTest | xsd:boolean? | Indikator, ob die Operation nur testweise ausgeführt wurde. (Testbetrieb) |
Als Einschränkung des Typs vct:ResponseType ist der Typ vct:TransactionResponseType definiert; die Einschränkung besteht darin, dass die Elemente vct:TransactionID und vct:StatusCode verwendet werden müssen. Der Typ vct:StatusCodeType ist eine Einschränkung des Typs xsd:integer auf die Zahlen 1 bis 199. Der Typ vct:ResponseCodeType ist eine Einschränkung des Typs xsd:positiveInteger auf die folgende Liste von Zahlen:
200 Operation wurde erfolgreich durchgeführt.
400 Allgemeiner Fehler in der Anfrage. Zu verwenden, wenn aufgrund der Anfrage keine Operation duchgeführt werden kann und der Fehler nicht unter einen der folgenden Fälle zu subsumieren ist.
404 Anfrage wird nicht unterstützt, d.h. die Anfrage entspricht zwar der Spezifikation, es handelt sich aber um eine optionale Operation, die dieser Server nicht implementiert.
405 Fehlerhafte Anfrage: Anfrage ist nicht die Serialisierung eines XML-Dokuments, das dem veloconnect-XML-Schema entspricht.
406 Fehlerhafte Anfrage: Anfrage ist die Serialisierung eines XML-Dokuments, das einem veralteten Stand der veloconnect-Spezifikation entspricht (vgl. Zukünftige Versionen).
410 Die angegebene BuyersID ist unbekannt.
411 Authentifzierung ist fehlgeschlagen (BuyersID oder Passwort falsch)
415 Die angegebene SellersID ist unbekannt. (obsolet)
420 Die angebene TransactionID ist unbekannt, d.h. die in der Anfrage spezifizierte Transaktionsinstanz existiert nicht auf dem Server.
421 Der Server kann keine weiteren Transaktionsinstanzen zu dieser Anfrage erzeugen.
430 Die angeforderte Operation ist im momentanen Zustand der Transaktioninstanz nicht anwendbar.
435 Der Wert des IsTest-Elements ist im gegenwärtigen Zustand der Transaktion nicht erlaubt. (vgl. Testbetrieb)
500 Ein interner Fehler ist aufgetreten, der den Server an der Durchführung der Operation hindert.
Regel ResponseCode (Client)
Bei jedem Response muss der Client den ResponseCode auswerten. Nur bei ResponseCode 200 darf der Response im Client weiter verarbeitet werden. Ansonsten darf der Response nicht verarbeitet werden und der Nutzer muss über den Fehler informiert werden. Dabei muss der Inhalt von ResponseMessage an den Nutzer weitergegeben werden, sofern er nicht leer ist. Ist ResponseMessage leer, kann im Fehlerfall der Client eine generische Fehlermeldung verwenden, die sich z.B. an den obigen Beschreibungen der ResponseCode Werte anlehnt.