Home >	Contents >	Index >
Template Tag TOC  |   Alpha TOC  |   Tag Family TOC  |   Purpose TOC  |   Annotated TOC  |   Index

SOAP.FAULT

Creates a status or error return message.

Syntax

<soap.fault
      code="error_code"
      string="error_as_string"
      [actor="cause_of_error"]
      [detail="error_details"] />
</soap.fault>

Parameters

code (required)

Code identifying the error. Default codes include:

• Version Mismatch
• MustUnderstand
• Client
• Server

string (required)

Error printed out as a string.

actor (optional)

Cause of the error.

detail (optional)

Detailed error information.

Description

SOAP messages can contain, at most, one status or error return message. This is called a SOAP fault element. Content Server does not check that more than one fault element is used. A fault element can be used for both error and status return.

The following table lists the default codes :

Error	Description
Version Mismatch	Invalid namespace for the SOAP Envelope element.
MustUnderstand	A child element of the Header element, with the mustUnderstand attribute set to "1", was not understood.
Client	The message was incorrectly formed or contained incorrect information.
Server	There was a problem with the server so the message could not proceed.

Example

This example code checks for an error, then displays the soap fault as the error message.

<IF COND="IsError.Variables.errno=true">
      <THEN>
            <soap.fault 
                  code="Server" 
                  string="Nothing to do!" 
                  actor="database" 
                  detail="Dummy"/>
      </THEN>
</IF>

See Also

SOAP.BODY

SOAP.HEADER

SOAP.MESSAGE

		Home >	Contents >	Index >
	FatWire XML Tag Reference Copyright 2005 by FatWire Software All rights reserved.