docs.intersystems.com
InterSystems IRIS Data Platform 2019.2  /  Web Services Quick Start Tutorial  /  Web Service Error Handling in InterSystems IRIS

Web Services Quick Start Tutorial
Overview: SOAP Faults
Previous section           Next section
InterSystems: The power behind what matters   
Search:  


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. With InterSystems IRIS you use %SOAP.Fault objects to work with Web Service errors. InterSystems IRIS Web Service producers automatically convert these objects to standard SOAP Fault elements before returning them to clients. InterSystems IRIS Web Service consumers automatically convert SOAP Fault elements received from producers into %SOAP.Fault objects.
%SOAP.Fault 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. InterSystems IRIS 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.


Previous section           Next section
Send us comments on this page
Download all PDFs
Copyright © 1997-2019 InterSystems Corporation, Cambridge, MA
Content Date/Time: 2019-09-19 06:56:35