|
|
WSYAPIWS/XMLAPI._Parameters.SetSoapFault
Note that this API is placed in the WYSAPIWS model.
The API is only available in the Java, WinC, WinC/iSeries versions of WebsydianExpress.
| Field | Variable | ...as | Description |
|---|---|---|---|
| FaultString | Input | Input | A description of the error you want to report to the client. |
The API is a memory parameter API.
The SOAP-standard describes a default structure containing a faultcode and a faultstring that must be returned to the client in error situations.
The faultstring is a descriptive text that explains details about the error. This API makes it possible for you to specify the text you want to report to the client.
The faultcode is one of several pre-defined values, but for all errors generated by the service handler, the code must be Server - so this field is not part of the API.
It is extremely important that you note that this is the error your customer/client will see - not an internal error that will be handled by the runtime.
The soap fault is only handled by the SoapServiceProcessor functions - if you call this API in service handlers called by any other service processors, the value will be disregarded.
The service processor retrieves the soap fault if the handler returns a return status that is not successful. If no faultstring has been written by the service handler, a default value for the faultstring is used.
Online documentation - WebsydianExpress v3.5