<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type='text/xsl' href='xmlspec.xsl'?>
<!DOCTYPE spec PUBLIC "-//W3C//DTD Specification V2.1//EN" "xmlspec.dtd"[
<!ENTITY % entities SYSTEM "entitieswd.dtd" >
<!ENTITY wgmb SYSTEM "http://www.w3.org/2000/xp/Group/wgmb.txt" >
<!ENTITY prevwgmb SYSTEM "http://www.w3.org/2000/xp/Group/prevwgmb.txt" >
<!ENTITY xop10 "http://www.w3.org/TR/2005/REC-xop10-20050125/" >
<!ENTITY soap-mtom "http://www.w3.org/TR/2005/REC-soap12-mtom-20050125/" >
<!ENTITY rrshb "http://www.w3.org/TR/2005/REC-soap12-rep-20050125/" >
<!ENTITY xday "25" >
<!ENTITY xmonth "January" >
<!ENTITY xyear "2005" >
<!ENTITY xschema2 "http://www.w3.org/TR/2004/REC-xmlschema-2-20041028/" >
<!ENTITY infoset "http://www.w3.org/TR/2004/REC-xml-infoset-20040204/" >
<!ENTITY mediatype "http://www.w3.org/TR/2005/NOTE-xml-media-types-20050504/" >
%entities;
]>
<spec w3c-doctype="per" role="edcopy">
  <header>
    <title>&name-part0;</title>
    <w3c-designation>&w3c-designation-part0;</w3c-designation>
    <w3c-doctype>&status;</w3c-doctype>
    <pubdate>
      <day>&draft.day;</day>
      <month>&draft.month;</month>
      <year>&draft.year;</year>
    </pubdate>
<!--
    <publoc><loc xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple" xlink:show="replace" xlink:actuate="onRequest" href="&dated-part0;/">&dated-part0;/</loc></publoc> -->
    <prevlocs><loc xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple" xlink:show="replace" xlink:actuate="onRequest" href="http://www.w3.org/TR/2006/PER-soap12-part0-20061219/">http://www.w3.org/TR/2006/PER-soap12-part0-20061219/</loc></prevlocs>
    <latestloc><loc xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple" xlink:show="replace" xlink:actuate="onRequest" href="http://www.w3.org/TR/&shortname-part0;/">http://www.w3.org/TR/&shortname-part0;/</loc></latestloc>

    <authlist>
      <author>
	<name>Nilo Mitra</name>
	<affiliation>Ericsson</affiliation>
      </author>
      <author>
	<name>Yves Lafon</name>
	<affiliation>W3C</affiliation>
      </author>
    </authlist>

<abstract>

<!-- <h2><a id="Ref477795601" name="Ref477795601">Abstract</a></h2> -->

<p>&name-part0; is a non-normative document intended to
provide an easily understandable tutorial on the features of SOAP Version
1.2. In particular, it describes the features through various usage
scenarios, and is intended to complement the normative text contained in <a
href="&dated-part1;">Part 1</a> and <a
href="&dated-part2;">Part 2</a> of the
SOAP 1.2 specifications. This second edition includes additional material on
the SOAP Message Transmission Optimization Mechanism (MTOM), the XML-binary
Optimized Packaging (XOP) and the Resource Representation SOAP Header Block
(RRSHB) specifications.</p>
</abstract>

<status>
<!--
<p><em>This section describes the status of this document at the time of its publication. Other documents may supersede this document. A list of current W3C publications and the latest revision of this technical report can be found in the <a href="http://www.w3.org/TR/">W3C technical reports index</a> at http://www.w3.org/TR/.</em></p>

<p>This document is a <a href="http://www.w3.org/2005/10/Process-20051014/tr.html#ProposedEditedRec">Proposed Edited Recommendation</a> of the W3C. It has been produced by the <a
href="http://www.w3.org/2000/xp/Group/">XML Protocol Working Group</a>, which
is part of the <a href="http://www.w3.org/2002/ws/Activity">Web Services
Activity</a>.
This second edition is not a new version of the SOAP1.2 Primer. Rather, as a convenience to readers, it incorporates the changes dictated by the accumulated <a href="http://www.w3.org/2003/06/REC-soap12-20030624-errata.html#Errata0">errata</a> to the <a href="http://www.w3.org/TR/2003/REC-soap12-part0-20030624/">original Recommendation</a>. Additionally, it incorporates changes to incorporate an overview of the <a href="&xop10;">XML-binary Optimized Packaging</a>, <a href="&soap-mtom;">SOAP Message Transmission Optimization Mechanism</a> and <a href="&rrshb;">Resource Representation SOAP Header Block</a> specifications and their usage. Changes between these two versions are described in a
<a href="diff-part0.html">diff document</a>.</p>

<p>Publication as a Proposed Edited Recommendation does not imply endorsement
by the W3C Membership. This is a draft document and may be updated, replaced or
obsoleted by other documents at any time. It is inappropriate to cite this
document as other than work in progress.</p>

<p>W3C Advisory Committee Representatives are invited to submit their formal review per the instructions in the Call for Review. Members of the public 
are also invited to send comments on this his Proposed Edited Recommendation to
the public
mailing-list <a href="mailto:xmlp-comments@w3.org">xmlp-comments@w3.org</a>
(<a href="http://lists.w3.org/Archives/Public/xmlp-comments/">archive</a>).
It is inappropriate to send discussion email to this address.</p>

<p>The review period extends to &per.review;.</p>

<p>Members of the W3C Advisory Committee will find the appropriate review form for this document by consulting their <a href="http://www.w3.org/2002/09/wbs/myQuestionnaires">list of current WBS questionnaires</a>.</p>

<p>Since the primary purpose of this specification is to present a set of
SOAP Version 1.2 specifications and fonctionalities, no implementation report is provided. However, the SOAP 1.2 Implementation Report can be found at <a
href="http://www.w3.org/2000/xp/Group/2/03/soap1.2implementation.html">
http://www.w3.org/2000/xp/Group/2/03/soap1.2implementation.html</a> and the
SOAP MTOM/XOP/RRSHB Implementation/Interop Summary can be found at <a
href="http://www.w3.org/2000/xp/Group/4/08/implementation.html">http://www.w3.org/2000/xp/Group/4/08/implementation.html</a>.</p>

<p> This document is governed by the <a href="http://www.w3.org/TR/2002/NOTE-patent-practice-20020124">24 January 2002 CPP</a> as amended by the <a href="http://www.w3.org/2004/02/05-pp-transition">W3C Patent Policy Transition Procedure</a>. This document is informative only. W3C maintains a <a rel="disclosure" href="http://www.w3.org/2000/xp/Group/2/10/16-IPR-statements.html">public list of any patent disclosures</a> made in connection with the deliverables of the group; that page also includes instructions for disclosing a patent. An individual who has actual knowledge of a patent which the individual believes contains <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/#def-essential">Essential Claim(s)</a> must disclose the information in accordance with <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/#sec-Disclosure">section 6 of the W3C Patent Policy</a>. </p>

<p>A list of current <a href="http://www.w3.org/TR/">W3C Recommendations and
other technical reports</a> can be found at <a
href="http://www.w3.org/TR">http://www.w3.org/TR</a>.</p>
-->
</status>

    <langusage>
      <language id="en">English</language>
    </langusage>
    <revisiondesc>
      <p>Last Modified: $Date: 2007/02/21 20:54:15 $</p>
    </revisiondesc>
  </header>

<!-- 
<h2><a id="Ref477795602" name="Ref477795602">Table of Contents</a></h2>
<dl>
  <dt><a href="#L1149">1. Introduction</a></dt>
    <dd><dl>
        <dt><a href="#L1153">1.1 Overview</a></dt>
        <dt><a href="#L1157">1.2 Notational Conventions</a></dt>
      </dl>
    </dd>
  <dt><a href="#L1161">2. Basic Usage Scenarios</a></dt>
    <dd><dl>
        <dt><a href="#L1165">2.1 SOAP Messages</a></dt>
        <dt><a href="#L1177">2.2 SOAP Message Exchange</a></dt>
          <dd><dl>
              <dt><a id="L171" href="#L977" name="L171">2.2.1 Conversational
              Message Exchanges</a></dt>
              <dt><a href="#L1185">2.2.2 Remote Procedure Calls</a></dt>
            </dl>
          </dd>
        <dt><a href="#L11549">2.3 Fault Scenarios</a></dt>
      </dl>
    </dd>
  <dt><a href="#L1244">3. SOAP Processing Model</a></dt>
    <dd><dl>
        <dt><a href="#L6293">3.1 The "role" Attribute</a></dt>
        <dt><a href="#L3031">3.2 The "mustUnderstand" Attribute</a></dt>
        <dt><a href="#L10047">3.3 The "relay" Attribute</a></dt>
      </dl>
    </dd>
  <dt><a href="#transport">4. Using Various Protocol Bindings</a></dt>
    <dd><dl>
        <dt><a href="#L10309">4.1 The SOAP HTTP Binding</a></dt>
          <dd><dl>
              <dt><a href="#L26854">4.1.1 SOAP HTTP GET Usage</a></dt>
              <dt><a href="#L26866">4.1.2 SOAP HTTP POST Usage</a></dt>
              <dt><a href="#L3677">4.1.3 Web Architecture Compatible SOAP
              Usage</a></dt>
            </dl>
          </dd>
      </dl>
    </dd>
    <dd><dl>
        <dt><a href="#SMTP">4.2 SOAP Over Email</a></dt>
      </dl>
    </dd>
  <dt><a href="#L579">5. Advanced Usage Scenarios</a></dt>
    <dd><dl>
        <dt><a href="#L635">5.1 Using SOAP Intermediaries</a></dt>
        <dt><a href="#L3374">5.2 Using Other Encoding Schemes</a></dt>
        <dt><a href="#L3360">5.3 Optimized Serialization of SOAP
        Messages</a></dt>
          <dd><dl>
              <dt><a href="#L3785">5.3.1 The Abstract SOAP Transmission
              Optimization Feature</a></dt>
              <dt><a href="#L3787">5.3.2 The Optimized Transmission
              Serialization Format</a></dt>
              <dt><a href="#L3791">5.3.3 Using the Resource Representation
              SOAP Header Block</a></dt>
            </dl>
          </dd>
      </dl>
    </dd>
  <dt><a href="#L4697">6. Changes Between SOAP 1.1 and SOAP 1.2</a></dt>
  <dt><a href="#L810">7. References</a></dt>
  <dt><a href="#L10313">A. Acknowledgements</a></dt>
  <dt><a href="#Change">B. Change Log</a></dt>
</dl>
-->

<body>
    <div1 id="intro">
      <head>Introduction</head>

<p>&name-part0; is a non-normative document intended to
provide an easily understandable tutorial on the features of the SOAP Version
1.2 specifications. Its purpose is to help a technically competent person
understand how SOAP may be used, by describing representative SOAP message
structures and message exchange patterns.</p>

<p>In particular, this primer describes the features of SOAP through various
usage scenarios, and is intended to complement the normative text contained
in <a href="&dated-part1;/">SOAP
Version 1.2 Part 1: Messaging Framework</a> (hereafter <a href="#L1092">[SOAP
Part1]</a>), <a
href="&dated-part2;/">SOAP Version 1.2
Part 2: Adjuncts</a> (hereafter <a href="#L1098">[SOAP Part2]</a>), the <a
href="&soap-mtom;">SOAP Message
Transmission Optimization Mechanism</a> (MTOM) (hereafter <a
href="#L9527">[MTOM]</a>), XML-binary Optimized Packaging <a
href="#L3777">[XOP]</a> and the Resource Representation SOAP Header Block <a
href="#L4299">[ResRep]</a> specifications.</p>

<p>It is expected that the reader has some familiarity with the basic syntax
of XML, including the use of XML namespaces and infosets, and Web concepts
such as URIs and HTTP. It is intended primarily for users of SOAP, such as
application designers, rather than implementors of the SOAP specifications,
although the latter may derive some benefit. This primer aims at highlighting
the essential features of SOAP Version 1.2, not at completeness in describing
every nuance or edge case. Therefore, there is no substitute for the main
specifications to obtain a fuller understanding of SOAP. To that end, this
primer provides extensive links to the main specifications wherever new
concepts are introduced or used.</p>

<p><a href="#L1092">[SOAP Part1]</a> defines the SOAP envelope, which is a
construct that defines an overall framework for representing the contents of
a SOAP message, identifying who should deal with all or part of it, and
whether handling such parts are optional or mandatory. It also defines a
protocol binding framework, which describes how the specification for a
binding of SOAP onto another underlying protocol may be written.</p>

<p><a href="#L1098">[SOAP Part2]</a> defines a data model for SOAP, a
particular encoding scheme for data types which may be used for conveying
remote procedure calls (RPC), as well as one concrete realization of the
underlying protocol binding framework defined in <a href="#L1092">[SOAP
Part1]</a>. This binding allows the exchange of SOAP messages either as
payload of a HTTP POST request and response, or as a SOAP message in the
response to a HTTP GET.</p>

<p><a href="#L9527">[MTOM] </a>describes an abstract feature for optimizing
the wire format of a SOAP message for certain type of content, as well as a
concrete implementation of it realized in an HTTP binding, while still
maintaining the modeling of a SOAP message as a single XML Infoset.</p>

<p><a href="#L3777">[XOP]</a>defines a convention for serializing more
efficiently an XML Infoset that has binary content. 
<a href="#L9527">[MTOM]</a> makes use of the
[<a href="#L3777">XOP</a>] format for optimizing the transmission of SOAP
messages.</p>

<p><a href="#L4299">[ResRep]</a> specifies a SOAP header block which carries a
representation of a Web resource, which is needed for processing a SOAP
message but which a receiver would prefer not to or cannot obtain by
dereferencing the URI for the resource carried within the message.</p>

<p>This document (the primer) is not normative, which means that it does not
provide the definitive specification of SOAP Version 1.2 or the other
specifications cited above. The examples provided here are intended to
complement the formal specifications, and in any question of interpretation
the formal specifications naturally take precedence. The examples shown here
provide a subset of the uses expected for SOAP. In actual usage scenarios,
SOAP will most likely be a part of an overall solution, and there will no
doubt be other application-specific requirements which are not captured in
these examples.</p>

<div2 id="L1153">
  <head>Overview</head>

<p>SOAP Version 1.2 provides the definition of the XML-based information
which can be used for exchanging structured and typed information between
peers in a decentralized, distributed environment. <a href="#L1092">[SOAP
Part1]</a> explains that a SOAP message is formally specified as an XML
Information Set [<a href="#R12">XML Infoset</a>] (henceforth often simply
infoset), which provides an abstract description of its contents. Infosets
can have different on-the-wire representations (aka serializations), one
common example of which is as an XML 1.0 [<a href="#L3532">XML 1.0</a>]
document. However, other serializations are also possible, and <a
href="#L9527">[MTOM]</a> using the [<a href="#L3777">XOP</a>] format offers
one mechanism for doing so for the cases where there is a need to optimize
the processing and size of the transmitted message.</p>

<p>SOAP is fundamentally a stateless, one-way message exchange paradigm, but
applications can create more complex interaction patterns (e.g.,
request/response, request/multiple responses, etc.) by combining such one-way
exchanges with features provided by an underlying protocol and/or
application-specific information. SOAP is silent on the semantics of any
application-specific data it conveys, as it is on issues such as the routing
of SOAP messages, reliable data transfer, firewall traversal, etc. However,
SOAP provides the framework by which application-specific information may be
conveyed in an extensible manner. Also, SOAP provides a full description of
the required actions taken by a SOAP node on receiving a SOAP message.</p>

<p><a href="#L1161">Section 2</a> of this document provides an introduction
to the basic features of SOAP starting with the simplest usage scenarios,
namely a one-way SOAP message, followed by various request-response type
exchanges, including RPCs. Fault situations are also described.</p>

<p><a href="#L3631">Section 3</a> provides an overview of the SOAP processing
model, which describes the rules for initial construction of a message, rules
by which messages are processed when received at an intermediary or ultimate
destination, and rules by which portions of the message can be inserted,
deleted or modified by the actions of an intermediary.</p>

<p><a href="#transport">Section 4</a> of this document describes the ways in
which SOAP messages may be transported to realize various usage scenarios. It
describes the SOAP HTTP binding specified in <a href="#L1098">[SOAP
Part2]</a>, as well as an example of how SOAP messages may be conveyed in
email messages. As a part of the HTTP binding, it introduces two message
exchange patterns which are available to an application, one of which uses
the HTTP POST method, while the other uses HTTP GET. Examples are also
provided on how RPCs, in particular those that represent "safe" information
retrieval, may be represented in SOAP message exchanges in a manner that is
compatible with the architectural principles of the World Wide Web .</p>

<p><a href="#L579">Section 5</a> of this document provides a treatment of
various aspects of SOAP that can be used in more complex usage scenarios.
These include the extensibility mechanism offered through the use of header
elements, which may be targeted at specific intermediate SOAP nodes to
provide value-added services to communicating applications, using various
encoding schemes to serialize application-specific data in SOAP messages, and
the means to provide a more optimized serialization of a SOAP message under
certain circumstances.</p>

<p><a id="Section" href="#L4697" name="Section">Section 6</a> of this
document describes the changes from <a
href="http://www.w3.org/TR/2000/NOTE-SOAP-20000508/">SOAP Version 1.1</a> [<a
href="#R11">SOAP 1.1</a>].</p>

<p><a href="#L810">Section 7</a> of this document provides references.</p>

<p>For ease of reference, terms and concepts used in this primer are
hyper-linked to their definition in the main specifications.</p>

</div2>

<div2 id="L1157">
  <head>Notational Conventions</head>

<p>Throughout this primer, sample SOAP envelopes and messages are shown as
[<a href="#L3532">XML 1.0</a>] documents. <a href="#L1092">[SOAP Part1]</a>
explains that a SOAP message is formally specified as an [<a href="#R12">XML
InfoSet</a>], which is an abstract description of its contents. The
distinction between the SOAP message infosets and their representation as XML
documents is unlikely to be of interest to those using this primer as an
introduction to SOAP; those who do care (typically those who port SOAP to new
protocol bindings where the messages may have alternative representations)
should understand these examples as referring to the corresponding XML
infosets. Further elaboration of this point is provided in <a
href="#transport">Section 4</a> of this document.</p>

<p>The namespace prefixes "env", "enc",  "rpc", "rep", "xop" and "xmime"
used in the prose sections of this document are associated with the namespace
names "<a
href="http://www.w3.org/2003/05/soap-envelope">http://www.w3.org/2003/05/soap-envelope</a>"
, "<a
href="http://www.w3.org/2003/05/soap-encoding">http://www.w3.org/2003/05/soap-encoding</a>",
"<a
href="http://www.w3.org/2003/05/soap-rpc">http://www.w3.org/2003/05/soap-rpc</a>",
<a
href="http://www.w3.org/2004/08/representation">"http://www.w3.org/2004/08/representation",
"</a><a
href="http://www.w3.org/2004/08/xop/include">http://www.w3.org/2004/08/xop/include</a>"
and "<a
href="http://www.w3.org/2004/11/xmlmime">http://www.w3.org/2004/11/xmlmime</a>"
respectively.</p>

<p>The namespace prefixes "xs" and "xsi" used in the prose sections of this
document are associated with the namespace names
"http://www.w3.org/2001/XMLSchema" and
"http://www.w3.org/2001/XMLSchema-instance" respectively, both of which are
defined in the XML Schema specifications <a href="#R7">[XML Schema
Part1]</a>, <a href="#R8">[XML Schema Part2]</a>.</p>

<p>Note that the choice of any other namespace prefix is arbitrary and not
semantically significant.</p>

<p>Namespace URIs of the general form "http://example.org/..." and
"http://example.com/..." represent an application-dependent or
context-dependent URI <a href="#RFC3986">[RFC 3986]</a>.</p>
</div2>
</div1>

<div1 id="L1161">
  <head>Basic Usage Scenarios</head>

<p>A <a
href="&dated-part1;/#encapsulation">
SOAP message</a> is fundamentally a one-way transmission between<a
href="&dated-part1;/#concepts"> SOAP
nodes</a>, from a <a
href="&dated-part1;/#senderreceiverconcepts">
SOAP sender</a> to a <a
href="&dated-part1;/#senderreceiverconcepts">
SOAP receiver</a>, but SOAP messages are expected to be combined by
applications to implement more complex interaction patterns ranging from
request/response to multiple, back-and-forth "conversational" exchanges.</p>

<p>The primer starts by exposing the structure of a SOAP message and its
exchange in some simple usage scenarios based on a travel reservation
application. Various aspects of this application scenario will be used
throughout the primer. In this scenario, the travel reservation application
for an employee of a company negotiates a travel reservation with a travel
booking service for a planned trip. The information exchanged between the
travel reservation application and the travel service application is in the
form of SOAP messages.</p>

<p>The ultimate recipient of a SOAP message sent from the travel reservation
application is the travel service application, but it is possible that the
SOAP message may be "routed" through one or more <a
href="&dated-part1;/#senderreceiverconcepts">
SOAP intermediaries</a> which act in some way on the message. Some simple
examples of such SOAP intermediaries might be ones that log, audit or,
possibly, amend each travel request. Examples, and a more detailed discussion
of the behavior and role of SOAP intermediaries, is postponed to <a
href="#L635">section 5.1</a>.</p>

<p><a href="#L1165">Section 2.1</a> describes a travel reservation request
expressed as a SOAP message, which offers the opportunity to describe the
various "parts" of a SOAP message.</p>

<p><a href="#L977">Section 2.2.1</a> continues the same scenario to show a
response from the travel service in the form of another SOAP message, which
forms a part of a conversational message exchange as the various choices
meeting the constraints of the travel request are negotiated.</p>

<p><a href="#L1185">Section 2.2.2</a> assumes that the various parameters of
the travel reservation have been accepted by the traveller, and an exchange -
modelled as a remote procedure call (RPC) - between the travel reservation
and the travel service applications confirms the payment for the
reservation.</p>

<p><a href="#L11549">Section 2.3</a> shows examples of fault handling.</p>

<div2 id="L1165">
    <head>SOAP Messages</head>

<p><a href="#Example">Example 1</a> shows data for a travel reservation
expressed in a <a
href="&dated-part1;/#encapsulation">
SOAP message</a>.</p>

<div class="exampleOuter">

<div class="exampleHead">
<a id="Example" name="Example">Example 1</a></div>

<div class="exampleInner">
<pre>&lt;?xml version='1.0' ?&gt;
&lt;env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope"&gt; 
 &lt;env:Header&gt;
  &lt;m:reservation xmlns:m="http://travelcompany.example.org/reservation" 
          env:role="http://www.w3.org/2003/05/soap-envelope/role/next"
           env:mustUnderstand="true"&gt;
   &lt;m:reference&gt;uuid:093a2da1-q345-739r-ba5d-pqff98fe8j7d&lt;/m:reference&gt;
   &lt;m:dateAndTime&gt;2001-11-29T13:20:00.000-05:00&lt;/m:dateAndTime&gt;
  &lt;/m:reservation&gt;
  &lt;n:passenger xmlns:n="http://mycompany.example.com/employees"
          env:role="http://www.w3.org/2003/05/soap-envelope/role/next"
           env:mustUnderstand="true"&gt;
   &lt;n:name&gt;Åke Jógvan Øyvind&lt;/n:name&gt;
  &lt;/n:passenger&gt;
 &lt;/env:Header&gt;
 &lt;env:Body&gt;
  &lt;p:itinerary
    xmlns:p="http://travelcompany.example.org/reservation/travel"&gt;
   &lt;p:departure&gt;
     &lt;p:departing&gt;New York&lt;/p:departing&gt;
     &lt;p:arriving&gt;Los Angeles&lt;/p:arriving&gt;
     &lt;p:departureDate&gt;2001-12-14&lt;/p:departureDate&gt;
     &lt;p:departureTime&gt;late afternoon&lt;/p:departureTime&gt;
     &lt;p:seatPreference&gt;aisle&lt;/p:seatPreference&gt;
   &lt;/p:departure&gt;
   &lt;p:return&gt;
     &lt;p:departing&gt;Los Angeles&lt;/p:departing&gt;
     &lt;p:arriving&gt;New York&lt;/p:arriving&gt;
     &lt;p:departureDate&gt;2001-12-20&lt;/p:departureDate&gt;
     &lt;p:departureTime&gt;mid-morning&lt;/p:departureTime&gt;
     &lt;p:seatPreference/&gt;
   &lt;/p:return&gt;
  &lt;/p:itinerary&gt;
  &lt;q:lodging
   xmlns:q="http://travelcompany.example.org/reservation/hotels"&gt;
   &lt;q:preference&gt;none&lt;/q:preference&gt;
  &lt;/q:lodging&gt;
 &lt;/env:Body&gt;
&lt;/env:Envelope&gt;</pre>
</div>

<div class="exampleWrapper">
Sample SOAP message for a travel reservation containing header blocks and a
body</div>
</div>

<p>The SOAP message in <a href="#Example">Example 1</a> contains two
SOAP-specific sub-elements within the overall <code><a
href="&dated-part1;/#soapenvelope">env:Envelope</a></code>,
namely an <code><a
href="&dated-part1;/#soaphead">env:Header</a></code>
and an <code><a
href="&dated-part1;/#soapbody">env:Body</a></code>.
The contents of these elements are application defined and not a part of the
SOAP specifications, although the latter do have something to say about how
such elements must be handled.</p>

<p>A <a
href="&dated-part1;/#encapsulation">
SOAP header</a> element is optional, but it has been included in the example
to explain certain features of SOAP. A SOAP header is an extension mechanism
that provides a way to pass information in SOAP messages that is not
application payload. Such "control" information includes, for example,
passing directives or contextual information related to the processing of the
message. This allows a SOAP message to be extended in an application-specific
manner. The immediate child elements of the <code>env:Header</code> element
are called<a
href="&dated-part1;/#encapsulation">
header blocks</a>, and represent a logical grouping of data which, as shown
later, can individually be targeted at SOAP nodes that might be encountered
in the path of a message from a sender to an ultimate receiver.</p>

<p>SOAP headers have been designed in anticipation of various uses for SOAP,
many of which will involve the participation of other SOAP processing nodes -
called <a
href="&dated-part1;/#senderreceiverconcepts">
SOAP intermediaries</a> - along a message's path from an <a
href="&dated-part1;/#senderreceiverconcepts">initial
SOAP sender</a> to an <a
href="&dated-part1;/#senderreceiverconcepts">ultimate
SOAP receiver</a>. This allows SOAP intermediaries to provide value-added
services. Headers, as shown later, may be inspected, inserted, deleted or
forwarded by SOAP nodes encountered along a <a
href="&dated-part1;/#senderreceiverconcepts">SOAP
message path</a>. (It should be kept in mind, though, that the SOAP
specifications do not deal with what the contents of header elements are, or
how SOAP messages are routed between nodes, or the manner by which the route
is determined and so forth. These are a part of the overall application, and
could be the subject of other specifications.)</p>

<p>The<a
href="&dated-part1;/#encapsulation">
SOAP body</a> is the mandatory element within the SOAP <code><a
href="&dated-part1;/#soapenvelope">env:Envelope</a></code>,
which implies that this is where the main end-to-end information conveyed in
a SOAP message must be carried.</p>

<p>A pictorial representation of the SOAP message in <a
href="#Example">Example 1</a> is as follows.</p>

<graphic id="img1" source="primer-figure-1.png" alt="SOAP message structure">
<caption>SOAP message structure</caption>
</graphic>

<p>In <a href="#Example">Example 1</a>, the header contains two header
blocks, each of which is defined in its own XML namespace and which represent
some aspect pertaining to the overall processing of the body of the SOAP
message. For this travel reservation application, such "meta" information
pertaining to the overall request is a <code>reservation</code> header block
which provides a reference and time stamp for this instance of a reservation,
and the traveller's identity in the <code>passenger</code> block.</p>

<p>The header blocks <code>reservation</code> and <code>passenger</code> must
be processed by the next SOAP intermediary encountered in the message path
or, if there is no intermediary, by the ultimate recipient of the message.
The fact that it is targeted at the next SOAP node encountered <em>en
route</em> is indicated by the presence of the attribute <code><a
href="&dated-part1;/#soaprole">env:role</a></code>
with the value "http://www.w3.org/2003/05/soap-envelope/role/next" (hereafter
simply "next"), which is a<a
href="&dated-part1;/#concepts">
role</a> that all SOAP nodes must be willing to play. The presence of an
<code>env:mustUnderstand</code> attribute with value "true" indicates that
the node(s) processing the header must absolutely process these header blocks
in a manner consistent with their specifications, or else not process the
message at all and throw a fault. Note that whenever a header block is
processed, either because it is marked <code>env:mustUnderstand="true"</code>
or for another reason, the block must be processed in accordance with the
specifications for that block. Such header block specifications are
application defined and not a part of SOAP. <a href="#L1244">Section 3</a>
will elaborate further on SOAP message processing based on the values of
these attributes.</p>

<p>The choices of what data is placed in a header block and what goes in the
SOAP body are decisions made at the time of application design. The main
point to keep in mind is that header blocks may be targeted at various nodes
that might be encountered along a message's path from a sender to the
ultimate recipient. Such intermediate SOAP nodes may provide value-added
services based on data in such headers. In <a href="#Example">Example 1</a>,
the passenger data is placed in a header block to illustrate the use of this
data at a SOAP intermediary to do some additional processing. For example, as
shown later in <a href="#L635">section 5.1,</a> the outbound message is
altered by the SOAP intermediary by having the travel policies pertaining to
this passenger appended to the message as another header block.</p>

<p>The <code><a
href="&dated-part1;/#soapbody">env:Body</a></code>
element and its associated child elements, <code>itinerary</code> and
<code>lodging</code>, are intended for exchange of information between the<a
href="&dated-part1;/#senderreceiverconcepts">
initial SOAP sender</a> and the SOAP node which assumes the role of the<a
href="&dated-part1;/#senderreceiverconcepts">
ultimate SOAP receiver</a> in the message path, which is the travel service
application. Therefore, the <code>env:Body</code> and its contents are
implicitly targeted and are expected to be understood by the ultimate
receiver. The means by which a SOAP node assumes such a role is not defined
by the SOAP specification, and is determined as a part of the overall
application semantics and associated message flow.</p>

<p>Note that a SOAP intermediary may decide to play the role of the ultimate
SOAP receiver for a given message transfer, and thus process the
<code>env:Body</code>. However, even though this sort of a behavior cannot be
prevented, it is not something that should be done lightly as it may pervert
the intentions of the message's sender, and have undesirable side effects
(such as not processing header blocks that might be targeted at
intermediaries further along the message path).</p>

<p>A SOAP message such as that in <a href="#Example">Example 1</a> may be
transferred by different underlying protocols and used in a variety of<a
href="&dated-part1;/#concepts"> message
exchange patterns</a>. For example, for a Web-based access to a travel
service application, it could be placed in the body of a HTTP POST request.
In another protocol binding, it might be sent in an email message (see <a
href="#SMTP">section 4.2</a>). <a href="#transport"> Section 4</a> will
describe how SOAP messages may be conveyed by a variety of underlying
protocols. For the time being, it is assumed that a mechanism exists for
message transfer and the remainder of this section concentrates on the
details of the SOAP messages and their processing.</p>

</div2>
<div2 id="L1177">
  <head>SOAP Message Exchange</head>

<p>SOAP Version 1.2 is a simple messaging framework for transferring
information specified in the form of an XML infoset between an initial SOAP
sender and an ultimate SOAP receiver. The more interesting scenarios
typically involve multiple message exchanges between these two nodes. The
simplest such exchange is a request-response pattern. Some early uses of [<a
href="#R11">SOAP 1.1</a>] emphasized the use of this pattern as means for
conveying remote procedure calls (RPC), but it is important to note that not
all SOAP request-response exchanges can or need to be modelled as RPCs. The
latter is used when there is a need to model a certain programmatic behavior,
with the exchanged messages conforming to a pre-defined description of the
remote call and its return.</p>

<p>A much larger set of usage scenarios than that covered by the
request-response pattern can be modeled simply as XML-based content exchanged
in SOAP messages to form a back-and-forth "conversation", where the semantics
are at the level of the sending and receiving applications. <a
href="#L977">Section 2.2.1</a> covers the case of XML-based content exchanged
in SOAP messages between the travel reservation application and the travel
service application in a conversational pattern, while <a
href="#L1185">section 2.2.2</a> provides an example of an exchange modeled as
an RPC.</p>

<div3 id="L977">
   <head>Conversational Message Exchanges</head>

<p>Continuing with the travel request scenario, <a href="#Example3">Example
2</a> shows a SOAP message returned from the travel service in response to
the reservation request message in <a href="#Example">Example 1</a>. This
response seeks to refine some information in the request, namely the choice
of airports in the departing city.</p>

<div class="exampleOuter">

<div class="exampleHead">
<a id="Example3" name="Example3">Example 2</a></div>

<div class="exampleInner">
<pre>&lt;?xml version='1.0' ?&gt;
&lt;env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope"&gt; 
 &lt;env:Header&gt;
  &lt;m:reservation xmlns:m="http://travelcompany.example.org/reservation" 
      env:role="http://www.w3.org/2003/05/soap-envelope/role/next"
           env:mustUnderstand="true"&gt;
   &lt;m:reference&gt;uuid:093a2da1-q345-739r-ba5d-pqff98fe8j7d&lt;/m:reference&gt;
   &lt;m:dateAndTime&gt;2001-11-29T13:35:00.000-05:00&lt;/m:dateAndTime&gt;
  &lt;/m:reservation&gt;
  &lt;n:passenger xmlns:n="http://mycompany.example.com/employees"
      env:role="http://www.w3.org/2003/05/soap-envelope/role/next"
           env:mustUnderstand="true"&gt;
   &lt;n:name&gt;Åke Jógvan Øyvind&lt;/n:name&gt;
  &lt;/n:passenger&gt;
 &lt;/env:Header&gt;
 &lt;env:Body&gt;
  &lt;p:itineraryClarification 
    xmlns:p="http://travelcompany.example.org/reservation/travel"&gt;
   &lt;p:departure&gt;
     &lt;p:departing&gt;
       &lt;p:airportChoices&gt;
          JFK LGA EWR 
       &lt;/p:airportChoices&gt;
     &lt;/p:departing&gt;
   &lt;/p:departure&gt;
   &lt;p:return&gt;
     &lt;p:arriving&gt;
       &lt;p:airportChoices&gt;
         JFK LGA EWR 
       &lt;/p:airportChoices&gt;
     &lt;/p:arriving&gt;
   &lt;/p:return&gt;  
  &lt;/p:itineraryClarification&gt;
 &lt;/env:Body&gt;
&lt;/env:Envelope&gt;</pre>
</div>

<div class="exampleWrapper">
SOAP message sent in response to the message in <a href="#Example">Example
1</a></div>
</div>

<p>As described earlier, the <code>env:Body</code> contains the primary
content of the message, which in this example includes a list of the various
alternatives for the airport, conforming to a schema definition in the XML
namespace http://travelcompany.example.org/reservation/travel. In this
example, the header blocks from <a href="#Example">Example 1</a> are returned
(with some sub-element values altered) in the response. This could allow
message correlation at the SOAP level, but such headers are very likely to
also have other application-specific uses.</p>

<p>The message exchange<span class="insert">s</span> in Examples 1 and 2 are
cases where XML-based contents conforming to some application-defined schema
are exchanged via SOAP messages. Once again, a discussion of the means by
which such messages are transferred is deferred to <a
href="#transport">section 4</a>.</p>

<p>It is easy enough to see how such exchanges can build up to a multiple
back-and-forth "conversational" message exchange pattern. <a
href="#Example4">Example 3</a> shows a SOAP message sent by the travel
reservation application in response to that in <a href="#Example3">Example
2</a> choosing one from the list of available airports. The header block
<code>reservation</code> with the same value of the <code>reference</code>
sub-element accompanies each message in this conversation, thereby offering a
way, should it be needed, to correlate the messages exchanged between them at
the application level.</p>

<div class="exampleOuter">

<div class="exampleHead">
<a id="Example4" name="Example4">Example 3</a></div>

<div class="exampleInner">
<pre>&lt;?xml version='1.0' ?&gt;
&lt;env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope"&gt; 
 &lt;env:Header&gt;
  &lt;m:reservation 
     xmlns:m="http://travelcompany.example.org/reservation" 
      env:role="http://www.w3.org/2003/05/soap-envelope/role/next"
           env:mustUnderstand="true"&gt;
    &lt;m:reference&gt;uuid:093a2da1-q345-739r-ba5d-pqff98fe8j7d&lt;/m:reference&gt;
    &lt;m:dateAndTime&gt;2001-11-29T13:36:50.000-05:00&lt;/m:dateAndTime&gt;
  &lt;/m:reservation&gt;
  &lt;n:passenger xmlns:n="http://mycompany.example.com/employees"
      env:role="http://www.w3.org/2003/05/soap-envelope/role/next"
           env:mustUnderstand="true"&gt;
   &lt;n:name&gt;Åke Jógvan Øyvind&lt;/n:name&gt;
  &lt;/n:passenger&gt;
 &lt;/env:Header&gt;
 &lt;env:Body&gt;
  &lt;p:itinerary 
   xmlns:p="http://travelcompany.example.org/reservation/travel"&gt;
   &lt;p:departure&gt;
     &lt;p:departing&gt;LGA&lt;/p:departing&gt;
   &lt;/p:departure&gt;
   &lt;p:return&gt;
     &lt;p:arriving&gt;EWR&lt;/p:arriving&gt;
   &lt;/p:return&gt;
  &lt;/p:itinerary&gt;
 &lt;/env:Body&gt;
&lt;/env:Envelope&gt;</pre>
</div>

<div class="exampleWrapper">
Response to the message in <a href="#Example3">Example 2</a> continuing a
conversational message exchange</div>
</div>
</div3>
<div3 id="L1185">
  <head>Remote Procedure Calls</head>

<p>One of the design goals of SOAP Version 1.2 is to encapsulate remote
procedure call functionality using the extensibility and flexibility of XML.
<a href="&dated-part2;/#soapforrpc">
SOAP Part 2 section 4</a> has defined a uniform representation for RPC
invocations and responses carried in SOAP messages. This section continues
with the travel reservation scenario to illustrate the use of SOAP messages
to convey remote procedure calls and their return.</p>

<p>To that end, the next example shows the payment for the trip using a
credit card. (It is assumed that the conversational exchanges described in <a
href="#L977">section 2.2.1</a> have resulted in a confirmed itinerary.) Here,
it is further assumed that the payment happens in the context of an overall
transaction where the credit card is charged only when the travel and the
lodging (not shown in any example, but presumably reserved in a similar
manner) are both confirmed. The travel reservation application provides
credit card information and the successful completion of the different
activities results in the card being charged and a reservation code returned.
This reserve-and-charge interaction between the travel reservation
application and the travel service application is modeled as a SOAP RPC.</p>

<p>To invoke a SOAP RPC, the following information is needed:</p>
<ol>
  <li id="underlying">The address of the target SOAP node.</li>
  <li>The procedure or method name.</li>
  <li>The identities and values of any arguments to be passed to the
    procedure or method together with any output parameters and return
  value.</li>
  <li id="clear">A clear separation of the arguments
    used to identify the Web resource which is the actual target for the RPC,
    as contrasted with those that convey data or control information used for
    processing the call by the target resource.</li>
  <li id="message">The
    message exchange pattern which will be employed to convey the RPC,
    together with an identification of the so-called "Web Method" (on which
    more later) to be used.</li>
  <li id="Optionally">Optionally, data which may be carried as a part of
    SOAP header blocks.</li>
</ol>

<p>Such information may be expressed by a variety of means, including formal
Interface Definition Languages (IDL). Note that SOAP does not provide any
IDL, formal or informal. Note also that the above information differs in
subtle ways from information generally needed to invoke other, non-SOAP
RPCs.</p>

<p>Regarding <a href="#underlying">Item 1</a> above, there is, from a SOAP
perspective, a SOAP node which "contains" or "supports" the target of the
RPC. It is the SOAP node which (appropriately) adopts the role of the <a
href="&dated-part1;/#senderreceiverconcepts">
ultimate SOAP receiver</a>. As required by <a href="#underlying">Item 1</a>,
the ultimate recipient can identify the target of the named procedure or
method by looking for its URI. The manner in which the target URI is made
available depends on the underlying protocol binding. One possibility is that
the URI identifying the target is carried in a SOAP header block. Some
protocol bindings, such as the SOAP HTTP binding defined in [<a
href="#L1098">SOAP Part2</a>], offer a mechanism for carrying the URI outside
the SOAP message. In general, one of the properties of a protocol binding
specification must be a description of how the target URI is carried as a
part of the binding. <a href="#L10309">Section 4.1</a> provides some concrete
examples of how the URI is carried in the case of the standardized SOAP
protocol binding to HTTP.</p>

<p><a href="#clear">Item 4</a> and <a>Item 5</a> above are required to ensure
that RPC applications that employ SOAP can do so in a manner which is
compatible with the architectural principles of the World Wide Web. <a
href="#L3677">Section 4.1.3</a> discusses how the information provided by
items 4 and 5 are utilized.</p>

<p>For the remainder of this section, it is assumed that the RPC conveyed in
a SOAP message as shown in <a href="#Example2">Example 4</a> is appropriately
targeted and dispatched. The purpose of this section is to highlight the
syntactical aspects of RPC requests and returns carried  within a SOAP
message.</p>

<div class="exampleOuter">

<div class="exampleHead">
<a id="Example2" name="Example2">Example 4</a></div>

<div class="exampleInner">
<pre>&lt;?xml version='1.0' ?&gt;
&lt;env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope" &gt;
 &lt;env:Header&gt;
   &lt;t:transaction
           xmlns:t="http://thirdparty.example.org/transaction"
           env:encodingStyle="http://example.com/encoding"
           env:mustUnderstand="true" &gt;5&lt;/t:transaction&gt;
 &lt;/env:Header&gt;  
 &lt;env:Body&gt;
  &lt;m:chargeReservation
      env:encodingStyle="http://www.w3.org/2003/05/soap-encoding"
         xmlns:m="http://travelcompany.example.org/"&gt;
   &lt;m:reservation xmlns:m="http://travelcompany.example.org/reservation"&gt;
    &lt;m:code&gt;FT35ZBQ&lt;/m:code&gt;
   &lt;/m:reservation&gt;
   &lt;o:creditCard xmlns:o="http://mycompany.example.com/financial"&gt;
    &lt;n:name xmlns:n="http://mycompany.example.com/employees"&gt;
           Åke Jógvan Øyvind
    &lt;/n:name&gt;
    &lt;o:number&gt;123456789099999&lt;/o:number&gt;
    &lt;o:expiration&gt;2005-02&lt;/o:expiration&gt;
   &lt;/o:creditCard&gt;
  &lt;/m:chargeReservation&gt;
 &lt;/env:Body&gt;
&lt;/env:Envelope&gt;</pre>
</div>

<div class="exampleWrapper">
SOAP RPC request with a mandatory header and two input (or "in")
parameters</div>
</div>

<p>The RPC itself is carried as a child of the <code>env:Body</code> element,
and is modelled as a <code>struct</code> which takes the name of the
procedure or method, in this case <code>chargeReservation</code>. (A
<code>struct</code> is <a
href="&dated-part2;/#values">a concept
from the SOAP Data Model</a> defined in [<a href="#L1098">SOAP Part2</a>]
that models a structure or record type that occurs in some common programming
languages.) The design of the RPC in the example (whose formal description
has not been explicitly provided) takes two input (or "in") parameters, the
<code>reservation</code> corresponding to the planned trip identified by the
reservation <code>code</code>, and the <code>creditCard</code> information.
The latter is also a <code>struct</code>, which takes three elements, the
card holder's <code>name</code>, the card <code>number</code> and an
<code>expiration</code> date.</p>

<p>In this example, the <code>env:encodingStyle</code> attribute with the
value <a
href="http://www.w3.org/2003/05/soap-encoding">http://www.w3.org/2003/05/soap-encoding</a>
shows that the contents of the <code>chargeReservation</code> structure have
been serialized according to the SOAP encoding rules, i.e., the particular
rules defined in<a
href="&dated-part2;/#soapenc"> SOAP
Part 2 section 3</a>. Even though SOAP specifies this particular encoding
scheme, its use is optional and the specification makes clear that other
encoding schemes may be used for application-specific data within a SOAP
message. It is for this purpose that it provides the
<code>env:encodingStyle</code> attribute to qualify header blocks and body
sub-elements. The choice of the value for this attribute is an
application-specific decision and the ability of a caller and callee to
interoperate is assumed to have been settled "out-of-band". <a
href="#L3374">Section 5.2</a> shows an example of using another encoding
scheme.</p>

<p>As noted in <a href="#Optionally">Item 6</a> above, RPCs may also require
additional information to be carried, which can be important for the
processing of the call in a distributed environment, but which are not a part
of the formal procedure or method description. (Note, however, that providing
such additional contextual information is not specific to RPCs, but may be
required in general for the processing of any distributed application.) In
the example, the RPC is carried out in the context of an overall transaction
which involves several activities which must all complete successfully before
the RPC returns successfully. <a href="#Example2">Example 4</a> shows how a
header block <code>transaction</code> directed at the ultimate recipient
(implied by the absence of the <code>env:role</code> attribute) is used to
carry such information. (The value "5" is some transaction identifier set by
and meaningful to the application. No further elaboration of the
application-specific semantics of this header are provided here, as it is not
germane to the discussion of the syntactical aspects of SOAP RPC
messages.)</p>

<p>Let us assume that the RPC in the charging example has been designed to
have the procedure description which indicates that there are two output (or
"out") parameters, one providing the reference code for the reservation and
the other a URL where the details of the reservation may be viewed. The RPC
response is returned in the <code>env:Body</code> element of a SOAP message,
which is modeled as a <code>struct</code> taking the procedure name
<code>chargeReservation</code> and, as a convention, the word "Response"
appended. The two output (or "out") parameters accompanying the response are
the alphanumeric <code>code</code> identifying the reservation in question,
and a URI for the location, <code>viewAt</code>, from where the reservation
may be retrieved.</p>

<p>This is shown in <a href="#Example5">Example 5a</a>, where the header
again identifies the transaction within which this RPC is performed.</p>

<div class="exampleOuter">

<div class="exampleHead">
<a id="Example5" name="Example5">Example 5a</a></div>

<div class="exampleInner">
<pre>&lt;?xml version='1.0' ?&gt;
&lt;env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope" &gt;
 &lt;env:Header&gt;
     &lt;t:transaction
        xmlns:t="http://thirdparty.example.org/transaction"
          env:encodingStyle="http://example.com/encoding"
           env:mustUnderstand="true"&gt;5&lt;/t:transaction&gt;
 &lt;/env:Header&gt;  
 &lt;env:Body&gt;
     &lt;m:chargeReservationResponse 
         env:encodingStyle="http://www.w3.org/2003/05/soap-encoding"
             xmlns:m="http://travelcompany.example.org/"&gt;
       &lt;m:code&gt;FT35ZBQ&lt;/m:code&gt;
       &lt;m:viewAt&gt;
         http://travelcompany.example.org/reservations?code=FT35ZBQ
       &lt;/m:viewAt&gt;
     &lt;/m:chargeReservationResponse&gt;
 &lt;/env:Body&gt;
&lt;/env:Envelope&gt;</pre>
</div>

<div class="exampleWrapper">
RPC response with two output (or "out") parameters for the call shown in <a
href="#Example2">Example 4</a></div>
</div>

<p>RPCs often have descriptions where a particular output parameter is
distinguished, the so-called "return" value. The<a
href="&dated-part2;/#rpcresponse"> SOAP
RPC convention</a> offers a way to distinguish this "return" value from the
other output parameters in the procedure description. To show this, the
charging example is modified to have an RPC description that is almost the
same as that for <a href="#Example5">Example 5a</a>, i.e, with the same two
"out" parameters, but in addition it also has a "return" value, which is an
enumeration with potential values of "confirmed" and "pending". The RPC
response conforming to this description is shown in <a
href="#Example51">Example 5b</a>, where the SOAP header, as before,
identifies the transaction within which this RPC is performed.</p>

<div class="exampleOuter">

<div class="exampleHead">
<a id="Example51" name="Example51">Example 5b</a></div>

<div class="exampleInner">
<pre>&lt;?xml version='1.0' ?&gt;
&lt;env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope" &gt;
 &lt;env:Header&gt;
    &lt;t:transaction
       xmlns:t="http://thirdparty.example.org/transaction"
         env:encodingStyle="http://example.com/encoding"
          env:mustUnderstand="true"&gt;5&lt;/t:transaction&gt;
 &lt;/env:Header&gt;  
 &lt;env:Body&gt;
    &lt;m:chargeReservationResponse 
       env:encodingStyle="http://www.w3.org/2003/05/soap-encoding"
           xmlns:rpc="http://www.w3.org/2003/05/soap-rpc"
             xmlns:m="http://travelcompany.example.org/"&gt;
       &lt;rpc:result&gt;m:status&lt;/rpc:result&gt;
       &lt;m:status&gt;confirmed&lt;/m:status&gt;
       &lt;m:code&gt;FT35ZBQ&lt;/m:code&gt;
       &lt;m:viewAt&gt;
        http://travelcompany.example.org/reservations?code=FT35ZBQ
       &lt;/m:viewAt&gt;
    &lt;/m:chargeReservationResponse&gt;
 &lt;/env:Body&gt;
&lt;/env:Envelope&gt;</pre>
</div>

<div class="exampleWrapper">
RPC response with a "return" value and two "out" parameters for the call
shown in <a href="#Example2">Example 4</a></div>
</div>

<p>In <a href="#Example51">Example 5b</a>, the return value is identified by
the element <code>rpc:result</code>, and contains the XML Qualified Name (of
type <code>xs:QName</code>) of another element within the <code>struct</code>
which is <code>m:status</code>. This, in turn, contains the actual return
value, "confirmed". This technique allows the actual return value to be
strongly typed according to some schema. If the <code>rpc:result</code>
element is absent, as is the case in <a href="#Example5">Example 5a</a>, the
return value is not present or is of the type <code>void</code>.</p>

<p>While, in principle, using SOAP for RPC is independent of the decision to
use a particular means for transferring the RPC call and its return, certain
protocol bindings that support the SOAP<a
href="&dated-part2;/#singlereqrespmep">
Request-Response message exchange pattern</a> may be more naturally suited
for such purposes. A protocol binding supporting this message exchange
pattern can provide the correlation between a request and a response. Of
course, the designer of an RPC-based application could choose to put a
correlation ID relating a call and its return in a SOAP header, thereby
making the RPC independent of any underlying transfer mechanism. In any case,
application designers have to be aware of all the characteristics of the
particular protocols chosen for transferring SOAP RPCs, such as latency,
synchrony, etc.</p>

<p>In the commonly used case, standardized in<a
href="&dated-part2;/#soapinhttp"> SOAP
Part 2 section 7</a>, of using HTTP as the underlying transfer protocol, an
RPC invocation maps naturally to the HTTP request and an RPC response maps to
the HTTP response. <a href="#L10309">Section 4.1</a> provides examples of
carrying RPCs using the HTTP binding.</p>

<p>However, it is worth keeping in mind that even though most examples of
SOAP for RPC use the HTTP protocol binding, it is not limited to that means
alone.</p>

 </div3>
</div2>

<div2 id="L11549">
  <head>Fault Scenarios</head>

<p>SOAP provides a model for handling situations when faults arise in the
processing of a message. SOAP distinguishes between the conditions that
result in a fault, and the ability to signal that fault to the originator of
the faulty message or another node. The ability to signal the fault depends
on the message transfer mechanism used, and one aspect of the binding
specification of SOAP onto an underlying protocol is to specify how faults
are signalled, if at all. The remainder of this section assumes that a
transfer mechanism is available for signalling faults generated while
processing received messages, and concentrates on the structure of the SOAP
fault message.</p>

<p>The SOAP <code>env:Body</code> element has another distinguished role in
that it is the place where such fault information is placed. The SOAP fault
model (see<a
href="&dated-part1;/#procsoapmsgs">
SOAP Part 1, section 2.6</a>) requires that all SOAP-specific and
application-specific faults be reported using a <em>single</em> distinguished
element, <code><a
href="&dated-part1;/#soapfault">
env:Fault</a></code>, carried within the <code>env:Body</code> element. The
<code>env:Fault</code> element contains two mandatory sub-elements, <code><a
href="&dated-part1;/#faultcodeelement">env:Code</a></code>
and <code><a
href="&dated-part1;/#faultstringelement">env:Reason</a></code>,
and (optionally) application-specific information in the <code><a
href="&dated-part1;/#faultdetailelement">env:Detail</a></code>
sub-element. Another optional sub-element,<code><a
href="&dated-part1;/#faultactorelement">
env:Node</a></code>, identifies via a URI the SOAP node which generated the
fault, its absence implying that it was the ultimate recipient of the message
which did so. There is yet another optional sub-element, <code><a
href="&dated-part1;/#faultroleelement">env:Role</a></code>,
which identifies the role being played by the node which generated the
fault.</p>

<p>The <code>env:Code</code> sub-element of <code>env:Fault</code> is itself
made up of a mandatory <code><a
href="&dated-part1;/#faultvalueelement">env:Value</a></code>
sub-element, whose content is specified in the SOAP specification (see<a
href="&dated-part1;/#faultcodes"> SOAP
Part 1 section 5.4.6</a>) as well as an optional <code><a
href="&dated-part1;/#faultsubcodeelement">env:Subcode</a></code>
sub-element.</p>

<p><a href="#Example7">Example 6a</a> shows a SOAP message returned in
response to the RPC request in <a href="#Example2">Example 4</a>, and
indicating a failure to process the RPC.</p>

<div class="exampleOuter">

<div class="exampleHead">
<a id="Example7" name="Example7">Example 6a</a></div>

<div class="exampleInner">
<pre>&lt;?xml version='1.0' ?&gt;
&lt;env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope"
            xmlns:rpc='http://www.w3.org/2003/05/soap-rpc'&gt;
  &lt;env:Body&gt;
   &lt;env:Fault&gt;
     &lt;env:Code&gt;
       &lt;env:Value&gt;env:Sender&lt;/env:Value&gt;
       &lt;env:Subcode&gt;
        &lt;env:Value&gt;rpc:BadArguments&lt;/env:Value&gt;
       &lt;/env:Subcode&gt;
     &lt;/env:Code&gt;
     &lt;env:Reason&gt;
      &lt;env:Text xml:lang="en-US"&gt;Processing error&lt;/env:Text&gt;
      &lt;env:Text xml:lang="cs"&gt;Chyba zpracování&lt;/env:Text&gt;
     &lt;/env:Reason&gt;
     &lt;env:Detail&gt;
      &lt;e:myFaultDetails 
        xmlns:e="http://travelcompany.example.org/faults"&gt;
        &lt;e:message&gt;Name does not match card number&lt;/e:message&gt;
        &lt;e:errorcode&gt;999&lt;/e:errorcode&gt;
      &lt;/e:myFaultDetails&gt;
     &lt;/env:Detail&gt;
   &lt;/env:Fault&gt;
 &lt;/env:Body&gt;
&lt;/env:Envelope&gt;</pre>
</div>

<div class="exampleWrapper">
Sample SOAP message indicating failure <span class="exampleWrapper">to
process the RPC in <a href="#Example2">Example 4</a></span></div>
</div>

<p>In <a href="#Example7">Example 6a</a>, the top-level
<code>env:Value</code> uses a standardized XML Qualified Name (of type
<code>xs:QName</code>) to identify that it is an <code>env:Sender</code>
fault, which indicates that it is related to some syntactical error or
inappropriate information in the message. (When a <code>env:Sender</code>
fault is received by the sender, it is expected that some corrective action
is taken before a similar message is sent again.) The
<code>env:Subcode</code> element is optional, and, if present, as it is in
this example, qualifies the parent value further. In <a
href="#Example7">Example 6a</a>, the <code>env:Subcode</code> denotes that an
RPC specific fault, <code>rpc:BadArguments</code>, defined in <a
href="&dated-part2;/#rpcfaults">SOAP
Part 2 section 4.4</a>, is the cause of the failure to process the
request.</p>

<p>The structure of the <code><a
href="&dated-part1;/#faultsubcodeelement">env:Subcode</a></code>
element has been chosen to be hierarchical - each child
<code>env:Subcode</code> element has a mandatory <code><a
href="&dated-part1;/#faultsubvalueelem">env:Value</a></code>
and an optional <code>env:Subcode</code> sub-element - to allow
application-specific codes to be carried. This hierarchical structure of the
<code>env:Code</code> element allows for an uniform mechanism for conveying
multiple level of fault codes. The top-level <code><a
href="&dated-part1;/#faultvalueelement">env:Value</a></code>
is a base fault that is specified in the SOAP Version 1.2 specifications (see
<a
href="&dated-part1;/#faultcodes">SOAP
Part 1 section 5.4.6</a>) and must be understood by all SOAP nodes. Nested
<code>env:Value</code>s are application-specific, and represent further
elaboration or refinement of the base fault from an application perspective.
Some of these values may well be standardized, such as the RPC codes
standardized in SOAP 1.2 (see<a
href="&dated-part2;/#rpcfaults"> SOAP
Part 2 section 4.4</a>), or in some other standards that use SOAP as an
encapsulation protocol. The only requirement for defining such
application-specific subcode values is that they be namespace qualified using
any namespace other than the SOAP <code><a
href="http://www.w3.org/2003/05/soap-envelope">env</a></code> namespace which
defines the main classifications for SOAP faults. There is no requirement
from a SOAP perspective that applications need to understand, or even look at
all levels of the subcode values.</p>

<p>The <code><a
href="&dated-part1;/#faultstringelement">env:Reason</a></code>
sub-element is not meant for algorithmic processing, but rather for human
understanding; so, even though this is a mandatory item, the chosen value
need not be standardized. Therefore all that is required is that it
reasonably accurately describe the fault situation. It must have one or more
<code><a
href="&dated-part1;/#reasontextelement">env:Text</a></code>
sub-elements, each with a unique <code>xml:lang</code> attribute, which
allows applications to make the fault reason available in multiple languages.
(Applications could negotiate the language of the fault text using a
mechanism built using SOAP headers; however this is outside the scope of the
SOAP specifications.)</p>

<p>The absence of a  <code>env:Node</code> sub-element within
<code>env:Fault</code> in <a href="#Example7">Example 6a</a> implies that it
is generated by the ultimate receiver of the call. The contents of
<code>env:Detail</code>, as shown in the example, are
application-specific.</p>

<p>During the processing of a SOAP message, a fault may also be generated if
a mandatory header element is not understood or the information contained in
it cannot be processed. Errors in processing a header block are also
signalled using a <code>env:Fault</code> element within the
<code>env:Body</code>, but with a particular distinguished header block,
<code><a
href="&dated-part1;/#soapnotunderstood">env:NotUnderstood</a></code>,
that identifies the offending header block.</p>

<p><a href="#Example12">Example 6b</a> shows an example of a response to the
RPC in <a href="#Example2">Example 4</a> indicating a failure to process the
<code>t:transaction</code> header block. Note the presence of the <code><a
href="&dated-part1;/#faultcodes">env:MustUnderstand</a></code>
fault code in the <code>env:Body</code>, and the identification of the header
not understood using an (unqualified) attribute, <code>qname</code>, in the
special (empty) header block <code>env:NotUnderstood</code>.</p>

<div class="exampleOuter">

<div class="exampleHead">
<a name="Example12" id="Example12">Example 6b</a></div>

<div class="exampleInner">
<pre>&lt;?xml version='1.0' ?&gt;
&lt;env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope"&gt;
 &lt;env:Header&gt;
    &lt;<span class="highlight">env:NotUnderstood</span> qname="t:transaction"
               xmlns:t="http://thirdparty.example.org/transaction"/&gt;
 &lt;/env:Header&gt;  
 &lt;env:Body&gt;
  &lt;env:Fault&gt;
   &lt;env:Code&gt;
    &lt;env:Value&gt;<span class="highlight">env:MustUnderstand</span>&lt;/env:Value&gt;
   &lt;/env:Code&gt;
   &lt;env:Reason&gt;
      &lt;env:Text xml:lang="en-US"&gt;Header not understood&lt;/env:Text&gt;
      &lt;env:Text xml:lang="fr"&gt;En-tête non compris&lt;/env:Text&gt;
   &lt;/env:Reason&gt;    
  &lt;/env:Fault&gt;
 &lt;/env:Body&gt;
&lt;/env:Envelope&gt;</pre>
</div>

<div class="exampleWrapper">
Sample SOAP message indicating failure <span class="exampleWrapper">to
process the header block in <a href="#Example2">Example 4</a></span></div>
</div>

<p>If there were several mandatory header blocks that were not understood,
then each could be identified by its <code>qname</code> attribute in a series
of such <code>env:NotUnderstood</code> header blocks.</p>

 </div2>
</div1>

<div1 id="L1244">
  <head><span id="L3631">SOAP Processing Model</span></head>

<p>Having established the various syntactical aspects of a SOAP message as
well as some basic message exchange patterns, this section provides a general
overview of the SOAP processing model (specified in<a
href="&dated-part1;/#msgexchngmdl">
SOAP Part 1, section 2</a>). The SOAP processing model describes the actions
taken by a SOAP node on receiving a SOAP message.</p>

<p><a href="#Example1">Example 7a</a> shows a SOAP message with several
header blocks (with their contents omitted for brevity). Variations of this
will be used in the remainder of this section to illustrate various aspects
of the processing model.</p>

<div class="exampleOuter">

<div class="exampleHead">
<a id="Example1" name="Example1">Example 7a</a></div>

<div class="exampleInner">
<pre>&lt;?xml version="1.0" ?&gt;
 &lt;env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope"&gt;
   &lt;env:Header&gt;
     &lt;p:oneBlock xmlns:p="http://example.com" 
            env:role="http://example.com/Log"&gt;
     ...
     ...
     &lt;/p:oneBlock&gt;
     &lt;q:anotherBlock xmlns:q="http://example.com"
       env:role="http://www.w3.org/2003/05/soap-envelope/role/next"&gt;
     ...
     ...
     &lt;/q:anotherBlock&gt;
     &lt;r:aThirdBlock xmlns:r="http://example.com"&gt;
     ...
     ...
     &lt;/r:aThirdBlock&gt;
   &lt;/env:Header&gt;
   &lt;env:Body &gt;
     ...
     ...
   &lt;/env:Body&gt;
 &lt;/env:Envelope&gt;</pre>
</div>

<div class="exampleWrapper">
SOAP message showing a variety of header blocks</div>
</div>

<p>The SOAP processing model describes the (logical) actions taken by a SOAP
node on receiving a SOAP message. There is a requirement for the node to
analyze those parts of a message that are SOAP-specific, namely those
elements in the SOAP "<a
href="http://www.w3.org/2003/05/soap-envelope">env</a>" namespace. Such
elements are the envelope itself, the header element and the body element. A
first step is, of course, the overall check that the SOAP message is
syntactically correct. That is, it conforms to the SOAP XML infoset subject
to the restrictions on the use of certain XML constructs - Processing
Instructions and Document Type Definitions - as defined in <a
href="&dated-part1;/#soapenv"> SOAP
Part 1, section 5.</a></p>

<div2 id="L1271">
   <head><span id="L6293">The "role" Attribute</span></head>

<p>Further processing of header blocks and the body depend on the<a
href="&dated-part1;/#concepts">
role</a>(s) assumed by the SOAP node for the processing of a given message.
SOAP defines the (optional) <code>env:role</code> attribute - syntactically,
<code>xs:anyURI</code> - that may be present in a header block, which
identifies the role played by the intended target of that header block. A
SOAP node is required to process a header block if it assumes the role
identified by the value of the URI. How a SOAP node assumes a particular role
is not a part of the SOAP specifications.</p>

<p>Three standardized roles have been defined (see<a
href="&dated-part1;/#soaproles"> SOAP
Part 1, section 2.2</a>), which are</p>
<ul>
  <li>"http://www.w3.org/2003/05/soap-envelope/role/none" (hereafter simply
    "none")</li>
  <li>"http://www.w3.org/2003/05/soap-envelope/role/next" (hereafter simply
    "next"), and</li>
  <li>"http://www.w3.org/2003/05/soap-envelope/role/ultimateReceiver"
    (hereafter simply "ultimateReceiver").</li>
</ul>

<p>In <a href="#Example1">Example 7a</a>, the header block
<code>oneBlock</code> is targeted at any SOAP node that plays the
application-defined role defined by the URI http://example.com/Log. For
purposes of illustration, it is assumed that the specification for such a
header block requires that any SOAP node adopting this role log the entire
message.</p>

<p>Every SOAP node receiving a message with a header block that has a
<code>env:role</code> attribute of "next" must be capable of processing the
contents of the element, as this is a standardized role that every SOAP node
must be willing to assume. A header block thus attributed is one which is
expected to be examined and (possibly) processed by the next SOAP node along
the path of a message, assuming that such a header has not been removed as a
result of processing at some node earlier in the message path.</p>

<p>In <a href="#Example1">Example 7a</a>, the header block
<code>anotherBlock</code> is targeted at the next node in the message path.
In <a href="#Example1"></a>this case, the SOAP message received by the node
playing the application-defined role of "http://example.com/Log", must also
be willing to play the SOAP-defined role of "next". This is also true for the
node which is the ultimate recipient of the message, as it obviously (and
implicitly) also plays the "next" role by virtue of being next in the message
path.</p>

<p>The third header block, <code>aThirdBlock</code>, in <a
href="#Example1">Example 7a</a> does not have the <code>env:role</code>
attribute. It is targeted at a SOAP node which assumes the "ultimateReceiver"
role. The "ultimateReceiver" role (which can be explicitly declared or is
implicit if the <code>env:role</code> attribute is absent in a header block)
is played by a SOAP node that assumes the role of the ultimate recipient of a
particular SOAP message. The absence of a <code>env:role</code> attribute in
the <code>aThirdBlock</code> header block means that this header element is
targeted at the SOAP node that assumes the "ultimateReceiver" role.</p>

<p>Note that the <code>env:Body</code> element does not have a
<code>env:role</code> attribute. The body element is <em>always</em> targeted
at the SOAP node that assumes the "ultimateReceiver" role. In that sense, the
body element is just like a header block targeted at the ultimate receiver,
but it has been distinguished to allow for SOAP nodes (typically SOAP
intermediaries) to skip over it if they assume roles other than that of the
ultimate receiver. SOAP does not prescribe any structure for the
<code>env:Body</code> element, except that it recommends that any
sub-elements be XML namespace qualified. Some applications, such as that in
<a href="#Example">Example 1</a>, may choose to organize the sub-elements of
<code>env:Body</code> in blocks, but this is not of concern to the SOAP
processing model.</p>

<p>The other distinguished role for the <code>env:Body</code> element, as the
container where information on SOAP-specific faults, i.e., failure to process
elements of a SOAP message, is placed has been described previously in <a
href="#L11549">section 2.3</a>.</p>

<p>If a header element has the standardized <code>env:role</code> attribute
with value "none", it means that no SOAP node should process the contents,
although a node may need to examine it if the content are data referenced by
another header element that is targeted at the particular SOAP node.</p>

<p>If the <code>env:role</code> attribute has an empty value, i.e.,
<code>env:role=""</code>, it means  that the relative URI identifying the
role is resolved to the base URI for the SOAP  message in question. SOAP
Version 1.2 does not define a base URI for a SOAP message, but defers  to the
mechanisms defined in [<a href="#L2778">XMLBase</a>] for deriving the base
URI, which can be used to make  any relative URIs absolute. One such
mechanism is for the protocol binding to establish a base URI,  possibly by
reference to the encapsulating protocol in which the SOAP  message is
embedded for transport. (In fact, when SOAP messages are transported  using
HTTP, <a
href="&dated-part2;/#httpuse">SOAP Part
2 section 7.1.2</a> defines the base URI as the  Request-URI of the HTTP
request,  or the value of the HTTP Content-Location header.)</p>

<p>The following table summarizes the applicable standardized roles that may
be assumed at various SOAP nodes. ("Yes" and "No" means that the
corresponding node does or does not, respectively, play the named role.)</p>

<table border="1"
summary="Table summarizing the applicable standardized roles that may be assumed at various SOAP nodes" id="tabrolesnodes">
  <tbody>
    <tr>
      <td align="right"><em>Role</em></td>
      <td align="center">absent</td>
      <td align="center">"none"</td>
      <td align="center">"next"</td>
      <td align="center">"ultimateReceiver"</td>
    </tr>
    <tr>
      <td><em>Node</em></td>
      <td align="center">&nbsp;</td>
      <td align="center">&nbsp;</td>
      <td align="center">&nbsp;</td>
      <td align="center">&nbsp;</td>
    </tr>
    <tr>
      <td>initial sender</td>
      <td align="center">not applicable</td>
      <td align="center">not applicable</td>
      <td align="center">not applicable</td>
      <td align="center">not applicable</td>
    </tr>
    <tr>
      <td>intermediary</td>
      <td align="center">no</td>
      <td align="center">no</td>
      <td align="center">yes</td>
      <td align="center">no</td>
    </tr>
    <tr>
      <td>ultimate receiver</td>
      <td align="center">yes</td>
      <td align="center">no</td>
      <td align="center">yes</td>
      <td align="center">yes</td>
    </tr>
  </tbody>
</table>

</div2>

<div2 id="L1474">
  <head><span id="L3031">The "mustUnderstand" Attribute</span></head>

<p><a href="#Example8">Example 7b</a> augments the previous example by
introducing another (optional) attribute for header blocks, the <code><a
href="&dated-part1;/#soapmu">env:mustUnderstand</a></code>
attribute.</p>

<div class="exampleOuter">

<div class="exampleHead">
<a id="Example8" name="Example8">Example 7b</a></div>

<div class="exampleInner">
<pre>&lt;?xml version="1.0" ?&gt;
 &lt;env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope"&gt;
   &lt;env:Header&gt;
     &lt;p:oneBlock xmlns:p="http://example.com" 
           env:role="http://example.com/Log" 
               <span class="highlight">env:mustUnderstand="true"</span>&gt;
     ...
     ...
     &lt;/p:oneBlock&gt;
     &lt;q:anotherBlock xmlns:q="http://example.com"
       env:role="http://www.w3.org/2003/05/soap-envelope/role/next"&gt;
     ...
     ...
     &lt;/q:anotherBlock&gt;
     &lt;r:aThirdBlock xmlns:r="http://example.com"&gt;
     ...
     ...
     &lt;/r:aThirdBlock&gt;
   &lt;/env:Header&gt;
   &lt;env:Body &gt;
     ...
     ...
   &lt;/env:Body&gt;
 &lt;/env:Envelope&gt;</pre>
</div>

<div class="exampleWrapper">
SOAP message showing a variety of header blocks, one of which is mandatory
for processing</div>
</div>

<p>After a SOAP node has correctly identified the header blocks (and possibly
the body) targeted at itself using the <code>env:role</code> attribute, the
additional attribute, <code>env:mustUnderstand</code>, in the header elements
determines further processing actions that have to be taken. In order to
ensure that SOAP nodes do not ignore header blocks which are important to the
overall purpose of the application, SOAP header blocks also provide for the
additional optional attribute, <code>env:mustUnderstand</code>, which, if
"true", means that the targeted SOAP node <em>must</em> process the
block according to the specification of that block. Such a block is
colloquially referred to as a mandatory header block. In fact, processing of
the SOAP message must not even start until the node has identified all the
mandatory header blocks targeted at itself, and "understood" them.
Understanding a header means that the node must be prepared to do whatever is
described in the specification of that block. (Keep in mind that the
specifications of header blocks are not a part of the SOAP
specifications.)</p>

<p>In <a href="#Example8">Example 7b</a>, the header block
<code>oneBlock</code> is marked with a <code>env:mustUnderstand</code> value
set to "true", which means that it is mandatory to process this block if the
SOAP node plays the role identified by "http://example.com/Log". The other
two header blocks are not so marked, which means that SOAP node at which
these blocks are targeted need not process them. (Presumably the
specifications for these blocks allow for this.)</p>

<p>A <code>env:mustUnderstand</code> value of "true" means that the SOAP node
must process the header with the semantics described in that header's
specification, or else generate a SOAP fault. Processing the header
appropriately may include removing the header from any generated SOAP
message, reinserting the header with the same or altered value, or inserting
a new header. The inability to process a mandatory header requires that all
further processing of the SOAP message cease, and a SOAP fault be generated.
The message is not forwarded any further.</p>

<p>The <code>env:Body</code> element has no <code>env:mustUnderstand</code>
attribute but it <em>must</em> be processed by the ultimate recipient. In <a
href="#Example8">Example 7b</a>, the ultimate recipient of the message - the
SOAP node which plays the "ultimateReceiver" role - must process the
<code>env:Body</code> and may process the header block
<code>aThirdBlock</code>. It may also process the header block
<code>anotherBlock</code>, as it is targeted at it (in the role of "next")
but it is not mandatory to do so if the specifications for processing the
blocks do not demand it. (If the specification for <code>anotherBlock</code>
demanded that it must be processed at the next recipient, it would have
required that it be marked with a <code>env:mustUnderstand=</code>"true".)</p>

<p>The role(s) a SOAP node plays when processing a SOAP message can be
determined by many factors. The role could be known<em> a priori</em>, or set
by some out-of-band means, or a node can inspect all parts of a received
message to determine which roles it will assume before processing the
message. An interesting case arises when a SOAP node, during the course of
processing a message, decides that there are additional roles that it needs
to adopt. No matter when this determination is made, externally it must
appear as though the processing model has been adhered to. That is, it must
appear as though the role had been known from the start of the processing of
the message. In particular, the external appearance must be that the
<code>env:mustUnderstand</code> checking of any headers with those additional
roles assumed was performed before any processing began. Also, if a SOAP node
assumes such additional roles, it must ensure that it is prepared to do
everything that the specifications for those roles require.</p>

<p>The following table summarizes how the processing actions for a header
block are qualified by the <code>env:mustUnderstand</code> attribute with
respect to a node that has been appropriately targeted (via the
<code>env:role</code> attribute).</p>

<table border="1"
summary="Table summarizing the use of the mustUnderstand attribute"
id="tabmustunderstand">
  <tbody>
    <tr>
      <td align="right"><em>Node</em></td>
      <td align="center">intermediary</td>
      <td align="center">ultimate receiver</td>
    </tr>
    <tr>
      <td><em>mustUnderstand</em></td>
      <td align="center">&nbsp;</td>
      <td align="center">&nbsp;</td>
    </tr>
    <tr>
      <td>"true"</td>
      <td align="center">must process</td>
      <td align="center">must process</td>
    </tr>
    <tr>
      <td>"false"</td>
      <td align="center">may process</td>
      <td align="center">may process</td>
    </tr>
    <tr>
      <td>absent</td>
      <td align="center">may process</td>
      <td align="center">may process</td>
    </tr>
  </tbody>
</table>

<p>As a result of processing a SOAP message, a SOAP node may generate a
single SOAP fault if it fails to process a message, or, depending on the
application, generate additional SOAP messages for consumption at other SOAP
nodes. <a
href="&dated-part1;/#soapfault">SOAP
Part 1 section 5.4</a> describes the structure of the fault message while the
<a
href="&dated-part1;/#msgexchngmdl">SOAP
processing model</a> defines the conditions under which it is generated. As
illustrated previously in <a href="#L11549">section 2.3</a>, a SOAP fault is
a SOAP message with a standardized <code>env:Body</code> sub-element named
<code>env:Fault</code>.</p>

<p>SOAP makes a distinction between generating a fault and ensuring that the
fault is returned to the originator of the message or to another appropriate
node which can benefit from this information. However, whether a generated
fault can be propagated appropriately depends on the underlying protocol
binding chosen for the SOAP message message exchange. The specification does
not define what happens if faults are generated during the propagation of
one-way messages. The only normative underlying protocol binding, which is
the SOAP HTTP binding, offers the HTTP response as a means for reporting a
fault in the incoming SOAP message. (See <a href="#transport">Section 4</a>
for more details on SOAP protocol bindings.)</p>

</div2>
<div2 id="LL10047">
  <head>The "relay" Attribute</head>

<p>SOAP Version 1.2 defines another optional attribute for header blocks,
<code><a
href="&dated-part1;/#soaprelay">env:relay</a></code>
of type <code>xs:boolean</code>, which indicates if a header block targeted
at a SOAP intermediary must be relayed if it is <em>not</em> processed.</p>

<p>Note that if a header block <em>is</em> processed, the SOAP processing
rules (see <a
href="&dated-part1;/#forwardinter">SOAP
Part 1 section 2.7.2</a>) requires that it be removed from the outbound
message. (It may, however, be reinserted, either unchanged or with its
contents altered, if the processing of other header blocks determines that
the header block be retained in the forwarded message.) The default behavior
for <em>an un</em>processed header block targeted at a role played by a SOAP
intermediary is that it must be removed before the message is relayed.</p>

<p>The reason for this choice of default is to lean on the side of safety by
ensuring that a SOAP intermediary make no assumptions about the survivability
past itself of a header block targeted at a role it assumes, and representing
some value-added feature, particularly if it chooses not to process the
header block, very likely because it does not "understand" it. That is
because certain header blocks represent hop-by-hop features, and it may not
make sense to unknowingly propagate it end-to-end. As an intermediary may not
be in a position to make this determination, it was thought that it would be
safer if unprocessed header blocks were removed before the message was
relayed.</p>

<p>However, there are instances when an application designer would like to
introduce a new feature, manifested through a SOAP header block, targeted at
<em>any</em> capable intermediary which might be encountered in the SOAP
message path. Such a header block would be available to those intermediaries
that "understood" it, but ignored and relayed onwards by those that did not.
Being a new feature, the processing software for this header block may be
implemented, at least initially, in some but not all SOAP nodes. Marking such
a header block with <code>env:mustUnderstand</code> = "false" is obviously
needed, so that intermediaries that have not implemented the feature do not
generate a fault. To circumvent the default rule of the processing model,
marking a header block with the additional attribute <code>env:relay</code>
with the value "true" allows the intermediary to forward the header block
targeted at itself in the event that it chooses not to process it.</p>

<p>Targeting the header block at the role "next" together with the
<code>env:relay</code> attribute set to "true" can always serve to ensure
that each intermediary has a chance to examine the header, because one of the
anticipated uses of the "next" role is with header blocks that carry
information that are expected to persist along a SOAP message path. Of
course, the application designer can always define a custom role that allows
targetting at specific intermediaries that assume this role. Therefore, there
is no restriction on the use of the <code>env:relay</code> attribute with any
role except of course the roles of "none" and "ultimateReceiver", for which
it is meaningless.</p>

<p><a href="#Example11">Example 7c</a> shows the use of the
<code>env:relay</code> attribute.</p>

<div class="exampleOuter">

<div class="exampleHead">
<a name="Example11" id="Example11">Example 7c</a></div>

<div class="exampleInner">
<pre>&lt;?xml version="1.0" ?&gt;
 &lt;env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope"&gt;
   &lt;env:Header&gt;
     &lt;p:oneBlock xmlns:p="http://example.com" 
           env:role="http://example.com/Log" 
               env:mustUnderstand="true"&gt;
     ...
     ...
     &lt;/p:oneBlock&gt;
     &lt;q:anotherBlock xmlns:q="http://example.com"
       env:role="http://www.w3.org/2003/05/soap-envelope/role/next"
       <span class="highlight">env:relay="true"</span>&gt;
     ...
     ...
     &lt;/q:anotherBlock&gt;
     &lt;r:aThirdBlock xmlns:r="http://example.com"&gt;
     ...
     ...
     &lt;/r:aThirdBlock&gt;
   &lt;/env:Header&gt;
   &lt;env:Body &gt;
     ...
     ...
   &lt;/env:Body&gt;
 &lt;/env:Envelope&gt;</pre>
</div>

<div class="exampleWrapper">
SOAP message showing a variety of header blocks, one of which must be relayed
if unprocessed.</div>
</div>

<p>The header block <code>q:anotherBlock</code>, targeted at the "next" node
in the message path, has the additional attribute
<code>env:relay</code>="true". A SOAP node receiving this message may process
this header block if it "understands" it, but if it does so the processing
rules require that this header block be removed before forwarding. However,
if the SOAP node chooses to ignore this header block, which it can because it
is not mandatory to process it, as indicated by the absence of the
<code>env:mustUnderstand</code> attribute, then it must forward it.</p>

<p>Processing the header block <code>p:oneBlock</code> is mandatory and the
SOAP processing rules require that it not be relayed, unless the processing
of some other header block requires that it be present in the outbound
message. The header block <code>r:aThirdBlock</code> does not have an
<code>env:relay</code> attribute, which is equivalent to having it with the
value of <code>env:relay </code>= "false". Hence, this header is not
forwarded if it is not processed.</p>

<p><a
href="&dated-part1;/#tabforwarding">SOAP
1.2 Part 1 Table 3</a> summarizes the conditions which determine when a SOAP
intermediary assuming a given role is allowed to forward unprocessed header
blocks.</p>
</div2>
</div1>

<div1 id="transport">
  <head>Using Various Protocol Bindings</head>

<p>SOAP messages may be exchanged using a variety of "underlying" protocols,
including other application layer protocols. The specification of how SOAP
messages may be passed from one SOAP node to another using an underlying
protocol is called a <a
href="&dated-part1;/#concepts">SOAP
binding</a>. <a href="#L1092">[SOAP Part1]</a> defines a SOAP message in the
form of an [<a href="#R12">XML Infoset</a>], i.e., in terms of element and
attribute information items of an abstract "document" called the
<code>env:Envelope</code> (see<a
href="&dated-part1;/#soapenv"> SOAP
Part 1, section 5</a>). Any SOAP <code>env:Envelope</code> infoset
representation will be made concrete through a protocol binding, whose task,
among other things, it is to provide a serialized representation of the
infoset that can be conveyed to the next SOAP node in the message path in a
manner such that the original infoset can be reconstructed without loss of
information.</p>

<p>In typical examples of SOAP messages, and certainly in all the examples in
this primer, the serialization shown is that of a well-formed [<a
href="#L3532">XML 1.0</a>] document. However, there may be
other protocol bindings - for example a protocol binding between two SOAP
nodes over a limited bandwidth interface - where an alternative, compressed
serialization of the same infoset may be chosen. Another binding, chosen for
a different purpose, may provide a serialization which is an encrypted
structure representing the same infoset. The <a href="#L9527">[MTOM]</a>
specification provides a SOAP binding to HTTP that allows for an optimized
serialization of the SOAP message infoset under certain circumstances. A more
detailed discussion of this binding is deferred to <a href="#L3360">Section
5.3</a>.</p>

<p>In addition to providing a concrete realization of a SOAP infoset between
adjacent SOAP nodes along a SOAP message path, a protocol binding provides
the mechanisms to support <a
href="&dated-part1;/#concepts">features</a>
that are needed by a SOAP application. A feature is a specification of a
certain functionality required in the interactions between two SOAP nodes,
which may be provided by a binding. A feature description is identified by a
URI, so that all applications referencing it are assured of the same
semantics. Features are qualified by <a
href="&dated-part2;/#bindprops">properties</a>,
which provide additional information that help in the implementation of the
feature. For example, a typical usage scenario might require many concurrent
request-response exchanges between adjacent SOAP nodes, in which case the
feature that is required is the ability to correlate a request with a
response. The abstract property associated with this feature is a
"correlation ID". Other examples includes "an encrypted channel" feature, or
a "reliable delivery channel" feature, or a particular <a
href="&dated-part1;/#soapmep">SOAP
message exchange pattern feature</a>. In particular, the <a
href="#L9527">[MTOM]</a> specification defines an <a
href="&soap-mtom;#feature">Abstract
SOAP Transmission Optimization feature</a> which may be used by SOAP bindings
to optimize the serialization of selected element information items of a SOAP
message infoset. (See <a href="#L3785">section 5.3.1</a> for details).</p>

<p>A SOAP binding specification (see <a
href="&dated-part1;/#transpbindframew">SOAP
Part 1 section 4</a>) describes, among other things, which (if any) features
it provides. Some features may be provided natively by the underlying
protocol. If the feature is not available through the binding, it may be
implemented within the SOAP envelope, using SOAP header blocks. The
specification of a feature implemented using SOAP header blocks is called a
<a
href="&dated-part1;/#soapmodules">SOAP
module</a>.</p>

<p>For example, if SOAP message exchanges were being transported directly
over a datagram protocol like UDP, obviously the message correlation feature
mentioned earlier would have to be provided by other means, either directly
by the application or more likely as a part of the SOAP infosets being
exchanged. In the latter case, the message correlation feature has a
binding-specific expression within the SOAP envelope, i.e., as a SOAP header
block, defined in a "Request-Response Correlation" module identified by a
URI. However, if the SOAP infosets were being exchanged using an underlying
protocol that was itself request/response, the application could implicitly
"inherit" this feature provided by the binding, and no further support need
be provided at the application or the SOAP level. (In fact, the HTTP binding
for SOAP takes advantage of just this feature of HTTP.) The Abstract SOAP
Transmission Optimization feature defined in <a href="#L9527"
class="insert">[MTOM]</a> is similarly implemented as a part of an augmented
SOAP HTTP binding, by serializing particular nodes of a SOAP message infoset
in binary format together with a modified SOAP Envelope, which are then
carried in separate parts of a MIME Multipart/Related <a href="#L3362">[RFC
2387]</a> package (see <a href="#L3787">section 5.3.2</a> for details).</p>

<p>However, a SOAP message may travel over several hops between a sender and
the ultimate receiver, where each hop may be a different protocol binding. In
other words, a feature (e.g., message correlation, reliability etc.) that is
supported by the protocol binding in one hop may not be supported by another
along the message path. SOAP itself does not provide any mechanism for hiding
the differences in features provided by different underlying protocols.
However, any end-to-end or multi-hop feature that is required by a particular
application, but which may not be available in the underlying infrastructure
along the <em>anticipated</em> message path, can be compensated for by being
carried as a part of the SOAP message infoset, i.e., as a SOAP header block
specified in some module.</p>

<p>Thus it is apparent that there are a number of issues that have to be
tackled by an application designer to accomplish particular application
semantics, including how to take advantage of the native features of
underlying protocols that are available for use in the chosen environment. <a
href="&dated-part1;/#bindfw">SOAP Part
1 section 4.2</a> provides a general framework for describing how SOAP-based
applications may choose to use the features provided by an underlying
protocol binding to accomplish particular application semantics. It is
intended to provide guidelines for writing interoperable protocol binding
specifications for exchanging SOAP messages.</p>

<p>Among other things, a binding specification must define one particular
feature, namely the message exchange pattern(s) that it supports. <a
href="#L1098">[SOAP Part2]</a> defines two such message exchange patterns,
namely a <a
href="&dated-part2;/#singlereqrespmep">
SOAP Request-Response message exchange pattern</a> where one SOAP message is
exchanged in each direction between two adjacent SOAP nodes, and a <a
href="&dated-part2;/#soapresmep"> SOAP
Response message exchange pattern</a> which consists of a non-SOAP message
acting as a request followed by a SOAP message included as a part of the
response.</p>

<p><a href="#L1098">[SOAP Part2]</a> also offers the application designer a
general feature called the <a
href="&dated-part2;/#WebMethodFeature">
SOAP Web Method feature</a> that allows applications full control over the
choice of the so-called "Web method" - one of GET, POST, PUT, DELETE whose
semantics are as defined in the [<a href="#L3133">HTTP 1.1</a>]
specifications - that may be used over the binding. This feature is defined
to ensure that applications using SOAP can do so in a manner which is
compatible with the architectural principles of the World Wide Web. (Very
briefly, the simplicity and scalability of the Web is largely due to the fact
that there are a few "generic" methods (GET, POST, PUT, DELETE) which can be
used to interact with any resource made available on the Web via a URI.) The
<a
href="&dated-part2;/#WebMethodFeature">SOAP
Web Method feature</a> is supported by the SOAP HTTP binding, although, in
principle, it is available to all SOAP underlying protocol bindings. <a
href="&dated-part2;/#soapinhttp"></a></p>

<p><a
href="&dated-part2;/#soapinhttp">SOAP
Part 2 section 7</a> specifies one standardized
protocol binding using the binding framework of <a href="#L1092">[SOAP
Part1]</a>, namely how SOAP is used in conjunction with HTTP as the
underlying protocol. SOAP Version 1.2 restricts itself to the definition of a
HTTP binding allowing only the use of the POST method in conjunction with the
Request-Response message exchange pattern and the GET method with the SOAP
Response message exchange pattern. Other specifications in future could
define SOAP bindings to HTTP or other transports that make use of the other
Web methods (i.e., PUT, DELETE).</p>

<p>The next sections show examples of two underlying protocol bindings for
SOAP, namely those to [<a href="#L3133">HTTP 1.1</a>] and email. It should be
emphasized again that the only normative binding for SOAP 1.2 messages is to
[<a href="#L3133">HTTP 1.1</a>]. The examples in <a href="#SMTP">section
4.2</a> showing email as a transport mechanism for SOAP is simply meant to
suggest that other choices for the transfer of SOAP messages are possible,
although not standardized at this time. A W3C Note [<a href="#L3215">SOAP
Email Binding</a>] offers an application of the SOAP protocol binding
framework of <a href="#L1092">[SOAP Part1]</a> by describing an experimental
binding of SOAP to email transport, specifically [<a href="#R9">RFC
2822</a>]-based message transport. The discussion of <a
href="#L9527">[MTOM]</a> and its concrete realization in an HTTP binding is
provided in <a href="#L3360">section 5.3</a>.</p>

<div2 id="L10309">
<head>The SOAP HTTP Binding</head>

<p>HTTP has a well-known connection model and a message exchange pattern. The
client identifies the server via a URI, connects to it using the underlying
TCP/IP network, issues a HTTP request message and receives a HTTP response
message over the same TCP connection. HTTP implicitly correlates its request
message with its response message; therefore, an application using this
binding can chose to infer a correlation between a SOAP message sent in the
body of a HTTP request message and a SOAP message returned in the HTTP
response. Similarly, HTTP identifies the server endpoint via a URI, the <a
href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec5.html#sec5.1.2">Request-URI</a>,
which can also serve as the identification of a SOAP node at the server.</p>

<p>HTTP allows for multiple intermediaries between the initial client and the
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec1.html#sec1.3">origin
server</a> identified by the Request-URI, in which case the request/response
model is a series of such pairs. Note, however, that HTTP intermediaries are
distinct from SOAP intermediaries.</p>

<p>The HTTP binding in <a href="#L1098">[SOAP
Part2]</a> makes use of the<a
href="&dated-part2;/#WebMethodFeature">SOAP
Web Method feature</a> to allow applications to choose the so-called Web
method - restricting it to one of GET or POST - to use over the HTTP message
exchange. In addition, it makes use of two message exchange patterns that
offer applications two ways of exchanging SOAP messages via HTTP: 1) the use of the
HTTP POST method for conveying SOAP messages in the bodies of HTTP request 
and response messages, and 2) the use of the HTTP GET
method in a HTTP request to return a SOAP message in the body of a HTTP
response. The first usage pattern is the HTTP-specific instantiation of a
binding feature called the <a href="&dated-part2;/#singlereqrespmep">SOAP request-response message exchange pattern</a>, while the second uses a feature
called the <a
href="&dated-part2;/#soapresmep">SOAP response message exchange pattern</a>.</p>

<p>The purpose of providing these two types of usages is
to accommodate the two interaction paradigms which are well established on
the World Wide Web. The first type of interaction allows for the use of data
within the body of a HTTP POST to create or modify the state of a resource
identified by the URI to which the HTTP request is destined. The second type
of interaction pattern offers the ability to use a HTTP GET request to obtain
a representation of a resource without altering its state in any way. In the
first case, the SOAP-specific aspect of concern is that the body of the HTTP
POST request is a SOAP message which has to be processed (per the SOAP
processing model) as a part of the application-specific processing required
to conform to the POST semantics. In the second case, the typical usage that
is forseen is the case where the representation of the resource that is being
requested is returned not as a HTML, or indeed a generic XML document, but as
a SOAP message. That is, the HTTP content type header of the response message
identifies it as being of media type "application/soap+xml" 
[<a href="#r13">RFC 3902</a>]. Presumably,
there will be publishers of resources on the Web who determine that such
resources are best retrieved and made available in the form of SOAP messages.
Note, however, that resources can, in general, be made available in multiple
representations, and the desired or preferred representation is indicated by
the requesting application using the HTTP <a
href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1">Accept</a>
header.</p>

<p>One further aspect of
the SOAP HTTP binding is the question of how an application determines which
of these two types of message exchange patterns to use.
<a href="#L1098">[SOAP Part2]</a> offers guidance on
circumstances when applications may use one of the two specified message
exchange patterns. (It is guidance - albeit a strong one - as it is phrased
in the form of a "<a href="http://www.ietf.org/rfc/rfc2119.txt">SHOULD</a>" in the
specifications rather than an absolute requirement identified by the word
"<a href="http://www.ietf.org/rfc/rfc2119.txt">MUST</a>", where these
words are interpreted as defined in the IETF [<a href="#L15789">RFC
2119</a>].) The SOAP response message exchange pattern with the HTTP GET
method is used when an application is assured that the message exchange is
for the purposes of information retrieval, where the information resource is
"untouched" as a result of the interaction. Such interactions are referred to
as <a
href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.1">safe and
idempotent</a> in the HTTP specification. As the
HTTP SOAP GET usage does not allow for a SOAP message in the request,
applications that need features in the outbound interaction that can only be
supported by a binding-specific expression within the SOAP infoset (i.e., as
SOAP header blocks) obviously cannot make use of this message exchange
pattern. Note that the HTTP POST binding is available for use in all
cases.</p>

<p>The following
subsections provide examples of the use of these two message exchange
patterns defined for the HTTP binding.</p>

<div3 id="L26854">
 <head>SOAP HTTP GET Usage</head>

<p>Using the HTTP binding with the <a
href="&dated-part2;/#soapresmep">SOAP Response message exchange pattern</a> is restricted to the HTTP GET method. This means that
the response to a HTTP GET request from a requesting SOAP node is a SOAP
message in the HTTP response.</p>

<p><a
href="#Ref4774883961121">Example 8a</a> shows a HTTP GET directed by the
traveller's application (in the continuing travel reservation scenario) at
the URI<code>
http://travelcompany.example.org/reservations?code=FT35ZBQ</code> >where the traveler's itinerary may be viewed. (How
this URL was made available can be seen in
<a href="#Example5">Example 5a</a>.)</p>

<div class="exampleOuter">

<div class="exampleHead">
<a id="Ref4774883961121" name="Ref4774883961121">Example 8a</a></div>

<div class="exampleInner">
<pre>GET /travelcompany.example.org/reservations?code=FT35ZBQ  HTTP/1.1
Host: travelcompany.example.org
Accept: text/html;q=0.5, application/soap+xml</pre>
</div>

<div class="exampleWrapper">
HTTP GET Request</div>
</div>

<p>The HTTP <a
href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1">Accept</a>
header is used to indicate the preferred representation of the resource being
requested, which in this example is an "application/soap+xml" media type for
consumption by a machine client, rather than the "text/html" media type for
rendition by a browser client for consumption by a human.</p>

<p><a href="#Example13">Example 8b</a> shows the HTTP
response to the GET in <a href="#Ref4774883961121">Example 8a</a>. The body
of the HTTP response contains a SOAP message showing the travel details. A
discussion of the contents of the SOAP message is postponed until <a
href="#L3374">section 5.2</a> , as it is not relevant, at this point, to
understanding the HTTP GET binding usage.</p>

<div class="exampleOuter">

<div class="exampleHead">
<a name="Example13" id="Example13">Example 8b</a></div>

<div class="exampleInner">
<pre>HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset="utf-8"
Content-Length: nnnn

&lt;?xml version='1.0' ?&gt;
&lt;env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope"&gt; 
 &lt;env:Header&gt;
  &lt;m:reservation xmlns:m="http://travelcompany.example.org/reservation" 
       env:role="http://www.w3.org/2003/05/soap-envelope/role/next"
           env:mustUnderstand="true"&gt;
   &lt;m:reference&gt;uuid:093a2da1-q345-739r-ba5d-pqff98fe8j7d&lt;/m:reference&gt;
   &lt;m:dateAndTime&gt;2001-11-30T16:25:00.000-05:00&lt;/m:dateAndTime&gt;
  &lt;/m:reservation&gt;
 &lt;/env:Header&gt;
 &lt;env:Body&gt;
  &lt;rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
            xmlns:x="http://travelcompany.example.org/vocab#"
     env:encodingStyle="http://www.w3.org/1999/02/22-rdf-syntax-ns#"&gt;
   &lt;x:ReservationRequest 
 rdf:about="http://travelcompany.example.org/reservations?code=FT35ZBQ"&gt;
      &lt;x:passenger&gt;Åke Jógvan Øyvind&lt;/x:passenger&gt;
      &lt;x:outbound&gt;
       &lt;x:TravelRequest&gt;
        &lt;x:to&gt;LAX&lt;/x:to&gt;
        &lt;x:from&gt;LGA&lt;/x:from&gt;
        &lt;x:date&gt;2001-12-14&lt;/x:date&gt;
       &lt;/x:TravelRequest&gt;
      &lt;/x:outbound&gt;
      &lt;x:return&gt;
       &lt;x:TravelRequest&gt;
        &lt;x:to&gt;JFK&lt;/x:to&gt;
        &lt;x:from&gt;LAX&lt;/x:from&gt;
        &lt;x:date&gt;2001-12-20&lt;/x:date&gt;
       &lt;/x:TravelRequest&gt;
      &lt;/x:return&gt;
    &lt;/x:ReservationRequest&gt;
  &lt;/rdf:RDF&gt;
 &lt;/env:Body&gt;
&lt;/env:Envelope&gt;</pre>
</div>

<div class="exampleWrapper">
SOAP message returned as a response to the HTTP GET in <a
href="#Ref4774883961121">Example 8a</a></div>
</div>

<p>Note that the
reservation details could well have been returned as an (X)HTML document, but
this example wanted to show a case where the reservation application is
returning the state of the resource (the reservation) in a data-centric media
form (a SOAP message) which can be machine processed, instead of (X)HTML
which would be processed by a browser. Indeed, in the most likely anticipated
uses of SOAP, the consuming application will not be a browser.</p>

<p>Also, as shown in the example, the use of
SOAP in the HTTP response body offers the possibility of expressing some
application-specific feature through the use of SOAP headers. By using SOAP,
the application is provided with a useful and consistent framework and
processing model for expressing such features.</p>

</div3>
<div3 id="L26866">
<head>SOAP HTTP POST Usage</head>

<p>Using the HTTP binding with the<a
href="&dated-part2;/#singlereqrespmep">
SOAP Request-Response message exchange pattern</a> is restricted to the HTTP
POST method. Note that the use of this message exchange pattern in the SOAP
HTTP binding is available to all applications, whether they involve the
exchange of general XML data or RPCs (as in the following examples)
encapsulated in SOAP messages.</p>

<p>Examples <a href="#Ref47748839611">9</a> and
<a href="#Ref47748860211">10</a> show an example of a HTTP binding
using the SOAP Request-Response message exchange
pattern, using the same scenario as that
for <a href="#Example2">Example 4</a> and <a href="#Example5">Example 5a</a>, respectively, namely conveying an RPC and its return
in the body of a SOAP message. The examples and discussion in this section
only concentrate on the HTTP headers and their role.</p>

<div class="exampleOuter">

<div class="exampleHead">
<a id="Ref47748839611" name="Ref47748839611">Example 9</a></div>

<div class="exampleInner">
<pre>POST /Reservations HTTP/1.1
Host: travelcompany.example.org
Content-Type: application/soap+xml; charset="utf-8"
Content-Length: nnnn

&lt;?xml version='1.0' ?&gt;
&lt;env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope" &gt;
 &lt;env:Header&gt;
   &lt;t:transaction
           xmlns:t="http://thirdparty.example.org/transaction"
           env:encodingStyle="http://example.com/encoding"
           env:mustUnderstand="true" &gt;5&lt;/t:transaction&gt;
 &lt;/env:Header&gt;  
 &lt;env:Body&gt;
  &lt;m:chargeReservation
     env:encodingStyle="http://www.w3.org/2003/05/soap-encoding"
          xmlns:m="http://travelcompany.example.org/"&gt;
   &lt;m:reservation xmlns:m="http://travelcompany.example.org/reservation"&gt;
    &lt;m:code&gt;FT35ZBQ&lt;/m:code&gt;
   &lt;/m:reservation&gt;
    &lt;o:creditCard xmlns:o="http://mycompany.example.com/financial"&gt;
     &lt;n:name xmlns:n="http://mycompany.example.com/employees"&gt;
           Åke Jógvan Øyvind
     &lt;/n:name&gt;
     &lt;o:number&gt;123456789099999&lt;/o:number&gt;
     &lt;o:expiration&gt;2005-02&lt;/o:expiration&gt;
    &lt;/o:creditCard&gt;
   &lt;/m:chargeReservation
  &lt;/env:Body&gt;
&lt;/env:Envelope&gt;</pre>
</div>

<div class="exampleWrapper">
RPC in <a href="#Example2">Example 4</a> carried in an HTTP POST Request</div>
</div>

<p><a href="#Ref47748839611">Example 9</a> shows an RPC request directed at
the travel service application. The SOAP message is sent in the body of a
HTTP POST method directed at the URI identifying the "Reservations" resource
on the server travelcompany.example.org. When using HTTP, the Request-URI
indicates the resource to which the invocation is "posted". Other than
requiring that it be a valid URI, SOAP places no <em>formal</em> restriction
on the form of the request URI (see <a href="#RFC3986">[RFC 3986]</a> for more
information on URIs). However, one of the principles of the Web architecture
is that all important resources be identified by URIs. This implies that most
well-architected SOAP services will be embodied as a large number of
resources, each with its own URI. Indeed, many such resources are likely to
be created dynamically during the operation of a service, such as, for
instance, the specific travel reservation shown in the example. So, a
well-architected travel service application should have different URIs for
each reservation, and SOAP requests to retrieve or manipulate those
reservations will be directed at their URIs, and not at a single monolithic
"Reservations" URI, as shown in <a href="#Ref47748839611">Example 9</a>. <a
href="#Ref477488396111"> Example 13</a> in <a href="#L3677">section 4.1.3</a>
shows the preferred way to address resources such as a particular travel
reservation. Therefore, we defer until <a href="#L3677">section 4.1.3</a>
further discussion of Web architecture compatible SOAP/HTTP usage.</p>

<p>When placing SOAP messages in HTTP bodies, the HTTP Content-type header
must be chosen as "application/soap+xml" [<a href="#r13">RFC 3902</a>]. (The
optional charset parameter, which can take the value of "<a
href="http://www.ietf.org/rfc/rfc2279.txt">utf-8</a>" or "<a
href="http://www.ietf.org/rfc/rfc2781.txt">utf-16</a>", is shown in this
example, but if it is absent the character set rules for freestanding [<a
href="#L3532">XML 1.0</a>] apply to the body of the HTTP request.)</p>

<p><a href="#Ref47748860211">Example 10</a> shows the RPC return (with
details omitted) sent by the travel service application in the corresponding
HTTP response to the request from <a href="#Example5">Example 5a</a>. SOAP,
using HTTP transport, follows the semantics of the HTTP status codes for
communicating status information in HTTP. For example, the 2xx series of HTTP
status codes indicate that the client's request (including the SOAP
component) was successfully received, understood, and accepted etc.</p>

<div class="exampleOuter">

<div class="exampleHead">
<a id="Ref47748860211" name="Ref47748860211">Example 10</a></div>

<div class="exampleInner">
<pre>HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset="utf-8"
Content-Length: nnnn

&lt;?xml version='1.0' ?&gt;
&lt;env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope" &gt;
 &lt;env:Header&gt;
       ...
       ...
 &lt;/env:Header&gt;  
 &lt;env:Body&gt;
       ...
       ...
 &lt;/env:Body&gt;
&lt;/env:Envelope&gt;</pre>
</div>

<div class="exampleWrapper">
RPC return in <a href="#Example5">Example 5a</a> embedded in an HTTP Response
indicating a successful completion</div>
</div>

<p>If an error occurs  processing the request, the HTTP binding specification
requires that a HTTP 500 "Internal Server Error" be used with an embedded
SOAP message containing a SOAP fault indicating the server-side processing
error.</p>

<p><a href="#Example10">Example 11</a> is the same SOAP fault message as <a
href="#Example7">Example 6a</a>, but this time with the HTTP headers
added.</p>

<div class="exampleOuter">

<div class="exampleHead">
<a name="Example10" id="Example10">Example 11</a></div>

<div class="exampleInner">
<pre>HTTP/1.1 500 Internal Server Error
Content-Type: application/soap+xml; charset="utf-8"
Content-Length: nnnn

&lt;?xml version='1.0' ?&gt;
&lt;env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope"&gt;
  &lt;env:Body&gt;
    &lt;env:Fault&gt;
     &lt;env:Code&gt;
       &lt;env:Value&gt;env:Sender&lt;/env:Value&gt;
       &lt;env:Subcode&gt;
        &lt;env:Value&gt;rpc:BadArguments&lt;/env:Value&gt;
       &lt;/env:Subcode&gt;
     &lt;/env:Code&gt;
     &lt;env:Reason&gt;
      &lt;env:Text xml:lang="en-US"&gt;Processing error&lt;/env:Text&gt;
      &lt;env:Text xml:lang="cs"&gt;Chyba zpracování&lt;/env:Text&gt;
     &lt;/env:Reason&gt;
     &lt;env:Detail&gt;
      &lt;e:myFaultDetails 
        xmlns:e="http://travelcompany.example.org/faults" &gt;
        &lt;e:message&gt;Name does not match card number&lt;/e:message&gt;
        &lt;e:errorcode&gt;999&lt;/e:errorcode&gt;
      &lt;/e:myFaultDetails&gt;
     &lt;/env:Detail&gt;
   &lt;/env:Fault&gt;
 &lt;/env:Body&gt;
&lt;/env:Envelope&gt;</pre>
</div>

<div class="exampleWrapper">
Sample SOAP message in a HTTP Response indicating failure <span
class="exampleWrapper">to handle the SOAP Body in <a href="#Example2">Example
4</a></span></div>
</div>

<p><a
href="&dated-part2;/#http-reqbindwaitstate">SOAP
Part 2 Table 16</a> provides detailed behavior for handling the various
possible HTTP response codes, i.e., the 2xx (successful), 3xx (redirection),
4xx (client error) and 5xx (server error).</p>

</div3>
<div3 id="L3677">
<head>Web Architecture Compatible SOAP Usage</head>

<p>One of the most central concepts of the World Wide Web is that of a URI as
a resource identifier. SOAP services that use the HTTP binding and wish to
interoperate with other Web software should use URIs to address all important
resources in their service. For example, a very important - indeed
predominant - use of the World Wide Web is pure information retrieval, where
the representation of an available resource, identified by a URI, is fetched
using a HTTP GET request without affecting the resource in any way. (This is
called a <a
href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.1">safe and
idempotent method</a> in HTTP terminology.) The
key point is that the publisher of a resource makes available its URI, which
consumers may "GET".</p>

<p>There are many
instances when SOAP messages are designed for uses which are purely for
information retrieval, such as when the state of some resource (or object, in
programming terms) is requested, as opposed to uses that perform resource
manipulation. In such instances, the use of a SOAP body to carry the request
for the state, with an element of the body representing the object in
question, is seen as counter to the spirit of the Web because the resource is
not identified by the Request-URI of the HTTP GET. (In some SOAP/RPC
implementations, the HTTP Request-URI is often not the identifier of the
resource itself but some intermediate entity which has to evaluate the SOAP
message to identify the resource.)</p>

<p>To highlight the changes needed, <a
href="#Example211">Example 12a</a> shows the way that is <em>not</em>
recommended for doing safe information retrieval on the Web. This is an
example of an RPC carried in a SOAP message, again using the travel
reservation theme, where the request is to retrieve the itinerary for a
particular reservation identified by one of the parameters,
<code>reservationCode</code>, of the RPC. (For purposes of this discussion,
it is assumed that the application using this RPC request does not need
features which require the use of SOAP headers.)</p>

<div class="exampleOuter">

<div class="exampleHead">
<a id="Example211" name="Example211">Example 12a</a></div>

<div class="exampleInner">
<pre>POST /Reservations HTTP/1.1
Host: travelcompany.example.org
Content-Type: application/soap+xml; charset="utf-8"
Content-Length: nnnn

&lt;?xml version='1.0' ?&gt;
&lt;env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope" &gt;
  &lt;env:Body&gt;
    &lt;m:retrieveItinerary 
        env:encodingStyle="http://www.w3.org/2003/05/soap-encoding"
             xmlns:m="http://travelcompany.example.org/"&gt;
      &lt;m:reservationCode&gt;FT35ZBQ&lt;/m:reservationCode&gt;
    &lt;/m:retrieveItinerary&gt;
  &lt;/env:Body&gt;
&lt;/env:Envelope&gt;</pre>
</div>

<div class="exampleWrapper">
This representation is discouraged in cases where the operation is a "safe"
retrieval (i.e., it has no side effects)</div>
</div>

<p>Note that the resource to be retrieved is not
identified by the target URI in the HTTP request but has to be obtained by
looking within the SOAP envelope. Thus, it is not possible, as would be the
case with other "gettable" URIs on the Web, to make this available via HTTP
alone to consumers on the World Wide Web.</p>

<p><a
href="&dated-part2;/#RPConWeb">SOAP
Part 2 section 4.1</a> offers recommendations on how RPCs that constitute
safe and idempotent information retrievals may be defined in a Web-friendly
manner. It does so by distinguishing aspects of the method and specific
parameters in an RPC definition that serve to identify resources from those
that serve other purposes. In <a href="#Example211">Example 12a</a>, the
resource to be retrieved is identified by two things: the first is that it is
an itinerary (part of the method name), and the second is the reference to a
specific instance (a parameter to the method). In such a case, the
recommendation is that these resource-identifying parts be made available in
the HTTP Request-URI identifying the resource, as for example, as follows:
<code>http://travelcompany.example.org/reservations/itinerary?reservationCode=FT35ZBQ</code>.</p>

<p>Furthermore, when an RPC definition is such that
all parts of its method description can be described as resource-identifying,
the entire target of the RPC may be identified by a URI. In this case, if the
supplier of the resource can also assure that a retrieval request is safe,
then SOAP Version 1.2 recommends that the choice of the Web method property
of GET and the use of the <a
href="&dated-part2;/#soapresmep"> SOAP
Response message exchange pattern</a> be used as described in <a
href="#L26854">section 4.1.1</a>. This will ensure that the SOAP RPC is
performed in a Web architecture compatible manner.  <a
href="#Ref4774883961111">Example 12b </a>shows the preferred way for a SOAP
node to request the safe retrieval of a resource.</p>

<div class="exampleOuter">

<div class="exampleHead">
<a id="Ref4774883961111" name="Ref4774883961111">Example 12b</a></div>

<div class="exampleInner">
<pre>GET /Reservations/itinerary?reservationCode=FT35ZBQ  HTTP/1.1
Host: travelcompany.example.org
Accept: application/soap+xml</pre>
</div>

<div class="exampleWrapper">
The Web architecture compatible alternative to representing the RPC in <a
href="#Example211">Example 12a</a></div>
</div>

<p>It should be noted that SOAP Version 1.2 does not
specify any algorithm on how to compute a URI from the definition of an RPC
which has been determined to represent pure information retrieval.</p>

<p>Note, however, that if
the application requires the use of features that can only have a
binding-specific expression within the SOAP infoset, i.e., using SOAP header
blocks, then the application must choose HTTP POST method with a SOAP message
in the request body.</p>

<p>It also requires the use of the <a
href="&dated-part2;/#singlereqrespmep"
>SOAP Request-Response message exchange pattern</a> implemented via a HTTP POST if the RPC description
includes data (parameters) which are not resource-identifying. Even in this
case, the HTTP POST with a SOAP message can be represented in a Web-friendly
manner. As with the use of the GET, <a href="#L1098">[SOAP Part2]</a>
recommends for the general case that any part of the SOAP message that serves
to identify the resource to which the request is POSTed be identified in the
HTTP Request-URI. The same parameters may, of course, be retained in the
SOAP <code>env:Body</code> element. (The parameters must be retained in the Body
in the case of a SOAP-based RPC as these are related to the procedure/method
description expected by the receiving application.)</p>

<p><a
href="#Ref477488396111">Example 13</a> is the same as that in <a
href="#Ref47748839611">Example 9</a>, except that the HTTP Request-URI has
been modified to include the reservation <code>code</code>, which serves to identify the
resource (the reservation in question, which is being confirmed and paid
for).</p>

<div class="exampleOuter">

<div class="exampleHead">
<a id="Ref477488396111" name="Ref477488396111">Example 13</a></div>

<div class="exampleInner">
<pre>POST /Reservations?code=FT35ZBQ HTTP/1.1
Host: travelcompany.example.org
Content-Type: application/soap+xml; charset="utf-8"
Content-Length: nnnn

&lt;?xml version='1.0'?&gt;
&lt;env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope" &gt;
 &lt;env:Header&gt;
   &lt;t:transaction
           xmlns:t="http://thirdparty.example.org/transaction"
           env:encodingStyle="http://example.com/encoding"
           env:mustUnderstand="true" &gt;5&lt;/t:transaction&gt;
 &lt;/env:Header&gt;  
 &lt;env:Body&gt;
  &lt;m:chargeReservation
      env:encodingStyle="http://www.w3.org/2003/05/soap-encoding"
         xmlns:m="http://travelcompany.example.org/"&gt;
   &lt;m:reservation xmlns:m="http://travelcompany.example.org/reservation"&gt;
    &lt;m:code&gt;FT35ZBQ&lt;/m:code&gt;
   &lt;/m:reservation&gt;
   &lt;o:creditCard xmlns:o="http://mycompany.example.com/financial"&gt;
    &lt;n:name xmlns:n="http://mycompany.example.com/employees"&gt;
           Åke Jógvan Øyvind
    &lt;/n:name&gt;
    &lt;o:number&gt;123456789099999&lt;/o:number&gt;
    &lt;o:expiration&gt;2005-02&lt;/o:expiration&gt;
   &lt;/o:creditCard&gt;
  &lt;/m:chargeReservation&gt;
 &lt;/env:Body&gt;
&lt;/env:Envelope&gt;</pre>
</div>

<div class="exampleWrapper">
RPC from <a href="#Example2">Example 4</a> carried in an HTTP POST Request in
a Web-friendly manner</div>
</div>

<p>In <a href="#Ref477488396111">Example 13</a>, the resource to be
manipulated is identified by two things: the first is that it  is a
reservation (part of the method name), and the second is the specific
instance of a reservation (which is the value of the parameter
<code>code</code> to the method). The remainder of the parameters in the RPC
such as the <code>creditCard</code> number are not resource-identifying, but
are ancillary data to be processed by the resource. It is the recommendation
of [<a href="#L1098">SOAP Part2</a>] that resources that may be accessed by
SOAP-based RPCs should, where practical, place any such resource-identifying
information as a part  of the URI identifying the target of the RPC. It
should be noted, however, that [<a href="#L1098">SOAP Part2</a>] does not
offer any algorithm to do so. Such algorithms may be developed in future.
Note, however, that  all the resource-identifying elements have been retained
as in <a href="#Ref47748839611">Example 9</a> in their encoded form in  the
SOAP <code>env:Body</code> element.</p>

<p>In other words, as seen from the above
examples, the recommendation in the SOAP specifications is to use URIs in a
Web-architecture compatible way - that is, as resource identifiers - whether
or not it is GET or POST that is used.</p>

</div3>
</div2>

<div2 id="SMTP">
<head>SOAP Over Email</head>

<p>Application developers can use the Internet email infrastructure to move
SOAP messages as either email text or attachments. The examples shown below
offer one way to carry SOAP messages, and should not be construed as being
the standard way of doing so. The SOAP Version 1.2 specifications do not
specify such a binding. However, there is a <em>non-normative</em> W3C Note
[<a href="#L3215">SOAP Email Binding</a>] describing an email binding for
SOAP, its main purpose being to demonstrate the application of the general
SOAP Protocol Binding Framework described in [<a href="#L1092">SOAP Part
1</a>].</p>

<p><a href="#Example14">Example 14</a> shows the travel reservation request
message from <a href="#Example">Example 1</a> carried as an email message
between a sending and receiving mail user agent. It is implied that the
receiver node  has SOAP capabilities, to which the body of the email is
delivered for processing. (It is assumed that the sending node also has SOAP
capabilities so as to be able to process any SOAP faults received in
response, or to correlate any SOAP messages received in response to this
one.)</p>

<div class="exampleOuter">

<div class="exampleHead">
<a id="Example14" name="Example14">Example 14</a></div>

<div class="exampleInner">
<pre>From: a.oyvind@mycompany.example.com
To: reservations@travelcompany.example.org
Subject: Travel to LA
Date: Thu, 29 Nov 2001 13:20:00 EST
Message-Id: &lt;EE492E16A090090276D208424960C0C@mycompany.example.com&gt;
Content-Type: application/soap+xml 

&lt;?xml version='1.0' ?&gt;
&lt;env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope"&gt; 
 &lt;env:Header&gt;
  &lt;m:reservation xmlns:m="http://travelcompany.example.org/reservation" 
      env:role="http://www.w3.org/2003/05/soap-envelope/role/next"
         env:mustUnderstand="true"&gt;
   &lt;m:reference&gt;uuid:093a2da1-q345-739r-ba5d-pqff98fe8j7d&lt;/m:reference&gt;
   &lt;m:dateAndTime&gt;2001-11-29T13:20:00.000-05:00&lt;/m:dateAndTime&gt;
  &lt;/m:reservation&gt;
  &lt;n:passenger xmlns:n="http://mycompany.example.com/employees"
      env:role="http://www.w3.org/2003/05/soap-envelope/role/next"
         env:mustUnderstand="true"&gt;
   &lt;n:name&gt;Åke Jógvan Øyvind&lt;/n:name&gt;
  &lt;/n:passenger&gt;
 &lt;/env:Header&gt;
 &lt;env:Body&gt;
  &lt;p:itinerary 
     xmlns:p="http://travelcompany.example.org/reservation/travel"&gt;
   &lt;p:departure&gt;
     &lt;p:departing&gt;New York&lt;/p:departing&gt;
     &lt;p:arriving&gt;Los Angeles&lt;/p:arriving&gt;
     &lt;p:departureDate&gt;2001-12-14&lt;/p:departureDate&gt;
     &lt;p:departureTime&gt;late afternoon&lt;/p:departureTime&gt;
     &lt;p:seatPreference&gt;aisle&lt;/p:seatPreference&gt;
   &lt;/p:departure&gt;
   &lt;p:return&gt;
     &lt;p:departing&gt;Los Angeles&lt;/p:departing&gt;
     &lt;p:arriving&gt;New York&lt;/p:arriving&gt;
     &lt;p:departureDate&gt;2001-12-20&lt;/p:departureDate&gt;
     &lt;p:departureTime&gt;mid morning&lt;/p:departureTime&gt;
     &lt;p:seatPreference/&gt;
   &lt;/p:return&gt;
  &lt;/p:itinerary&gt;
  &lt;q:lodging 
     xmlns:q="http://travelcompany.example.org/reservation/hotels"&gt;
   &lt;q:preference&gt;none&lt;/q:preference&gt;
  &lt;/q:lodging&gt;
 &lt;/env:Body&gt;
&lt;/env:Envelope&gt;</pre>
</div>

<div class="exampleWrapper">
SOAP message from <a href="#Example">Example 1</a> carried in a SMTP
message</div>
</div>

<p>The header in <a href="#Example14">Example 14</a> is in the standard form
[<a href="#R9">RFC 2822</a>] for email messages.</p>

<p>Although an email is a one-way message exchange, and no guarantee of
delivery is provided, email infrastructures like the Simple Mail Transport
Protocol (SMTP) specification [<a href="#R9">SMTP</a>] offer a delivery
notification mechanism which, in the case of SMTP, are called Delivery Status
Notification (DSN) and Message Disposition Notification (MDN). These
notifications take the form of email messages sent to the email address
specified in the mail header. Applications, as well as email end users, can
use these mechanisms to provide the status of an email transmission, but
these, if delivered, are notifications at the SMTP level. The application
developer must fully understand the capabilities and limitations of these
delivery notifications or risk assuming a successful data delivery when none
occurred.</p>

<p>SMTP delivery status messages are separate from message processing at the
SOAP layer. Resulting SOAP responses to the contained SOAP data will be
returned through a new email message which may or may not have a link to the
original requesting email at the SMTP level. The use of the [<a
href="#R9">RFC 2822</a>] <code>In-reply-to:</code> header can achieve a
correlation at the SMTP level, but does not necessarily offer a correlation
at the SOAP level.</p>

<p><a href="#Example31">Example 15</a> is exactly the same scenario as
described for <a href="#Example3">Example 2</a>, which shows the SOAP message
(body details omitted for brevity) sent from the travel service application
to the travel reservation application seeking clarification on some
reservation details, except that it is carried as an email message. In this
example, the original email's<code> Message-Id</code> is carried in the
additional email header <code>In-reply-to:</code>, which correlates email
messages at the SMTP level, but cannot provide a SOAP-specific correlation.
In this example, the application relies on the <code>reservation</code>
header block to correlate SOAP messages. Again, how such correlation is
achieved is application-specific, and is not within the scope of SOAP.</p>

<div class="exampleOuter">

<div class="exampleHead">
<a id="Example31" name="Example31">Example 15</a></div>

<div class="exampleInner">
<pre>From: reservations@travelcompany.example.org
To: a.oyvind@mycompany.example.com
Subject: Which NY airport?
Date: Thu, 29 Nov 2001 13:35:11 EST
Message-Id: &lt;200109251753.NAA10655@travelcompany.example.org&gt;
In-reply-to:&lt;EE492E16A090090276D208424960C0C@mycompany.example.com&gt;
Content-Type: application/soap+xml

&lt;?xml version='1.0' ?&gt;
&lt;env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope"&gt; 
 &lt;env:Header&gt;
  &lt;m:reservation xmlns:m="http://travelcompany.example.org/reservation" 
     env:role="http://www.w3.org/2003/05/soap-envelope/role/next"
       env:mustUnderstand="true"&gt;
   &lt;m:reference&gt;uuid:093a2da1-q345-739r-ba5d-pqff98fe8j7d&lt;/m:reference&gt;
   &lt;m:dateAndTime&gt;2001-11-29T13:35:00.000-05:00&lt;/m:dateAndTime&gt;
  &lt;/m:reservation&gt;
  &lt;n:passenger xmlns:n="http://mycompany.example.com/employees"
      env:role="http://www.w3.org/2003/05/soap-envelope/role/next"
        env:mustUnderstand="true"&gt;
   &lt;n:name&gt;Åke Jógvan Øyvind&lt;/n:name&gt;
  &lt;/n:passenger&gt;
 &lt;/env:Header&gt;
 &lt;env:Body&gt;
  &lt;p:itinerary
     xmlns:p="http://travelcompany.example.org/reservation/travel"&gt;
   &lt;p:itineraryClarifications&gt;
      ...
      ...
   &lt;/p:itineraryClarifications&gt;
  &lt;/p:itinerary&gt;
 &lt;/env:Body&gt;
&lt;/env:Envelope&gt;</pre>
</div>

<div class="exampleWrapper">
SOAP message from <a href="#Example3">Example 2</a> carried in an email
message with a header correlating it to a previous message.</div>
</div>

