Messages in case of error

Error handling conforms to SOAP-standard that means that a so called SOAP-Exception is sent back in case of error. This gives detailed information about where the error occured and what kind of error is involved.

An example for an SOAP-Exception is given in the following section.

<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope
    soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soap:Body>
        <soap:Fault>
            <faultcode>SAP/DSB/JDM01002</faultcode>
            <faultstring>[SAP/DSB/JDM01002] The sap function returned an error</faultstring>
            <faultactor>Client</faultactor>
            <detail>
                <message system="avs3" version="1.0">
                    <header>
                        <client/>
                    </header>
                    <body>
                        <description>The sap function returned an error</description>
                        <code>SAP/DSB/JDM01002<//code>
                        <timestamp>2003-08-06 11:03:15</timestamp>
                        <sap-exception>
                            <msgid>/DSB/JDM01</msgid>
                            <msgno>002</msgno>
                            <msgtype>E</msgtype>
                            <msgv1/>
                            <msgv2/>
                            <msgv3>/DSB/JWT_BQ</msgv3>
                            <msgv4/>
                            <msgtext>Kein Eintrag zur Selektion in Tabelle /DSB/JWT_BQ vorhanden.</msgtext>
                        </sap-exception>
                        <sap-result>
                            <OUT_STAPEL>03227ABOser060803</OUT_STAPEL>
                        </sap-result>
                    </body>
                </message>
            </detail>
        </soap:Fault>
    </soap:Body>
</soap:Envelope>

A SOAP-Exception comprises 4 parts:

Fault code: This comprises a fault code which describe the error as machine-readable. The fault codes which can occur in each web services of dsb are shown in the next section.

Fault string: According to specification is here to state an error description in a human being readable format. This String comprises therefore at the web services of dsb from the above mentioned fault codes and a description of this mistake. Those strings are shown in the next section to corresponding available fault codes.

Faultactor: this field should state where the cause of the error is to be searched. Possible values are ‚Client‘ and ‚Server‘, depending on the error if is causally in the client program, (this means call in of the web service) or it must be searched in the server.

Detail: Comprises specific used error information. On the other hand is this information coded as XML-message. Usually this comprises still an in-depth description of the errror and maybe also specific used information for the client.

In direction only very few SOAP-Exceptions of the Detail-Tag is evaluated.

If a framework is used to create and to send SOAP-messages, so exists normally a possibility in case of a SOAP-Exception to have directly access to these 4 fields respectively to evaluate them.

In the next sections for each web service is described which fault codes of each SOAP-Exceptions of the web service can occur and what to do in this matter.