Skip to main content

Overview: SOAP Faults

The SOAP specification provides the Fault element as a standard mechanism for returning error messages from Web Service producers. The element contains useful information about the particular error that caused it. In Caché you use %SOAP.FaultOpens in a new tab objects to work with Web Service errors. Caché Web Service producers automatically convert these objects to standard SOAP Fault elements before returning them to clients. Caché Web Service consumers automatically convert SOAP Fault elements received from producers into %SOAP.FaultOpens in a new tab objects.

%SOAP.FaultOpens in a new tab contains the following properties:

Property Description
detail
Contains information about the cause of the fault.
faultactor
Contains the URI of the service that generated the fault.
faultcode
Contains the SOAP fault code as defined by the SOAP specification. Caché provides the following macros for the fault code elements:
  • $$$FAULTVersionMismatch — Incompatible SOAP Versions between client and server.
  • $$$FAULTMustUnderstand — Header has a MustUnderstand attribute which the Server could not understand.
  • $$$FAULTClient — Client made an incorrect/incomplete request
  • $$$FAULTServer — Server side error
faultstring
Contains a human-readable explanation of the cause of the fault.
FeedbackOpens in a new tab