Home > Articles > Web Services > XML

An Overview of the SOAP v1.1 Specification

SOAP allows business software programs to communicate over the Internet regardless of the platform on which they are based. This article discusses SOAP v1.1 specification topics, including, using XML in SOAP, http as a base transport, and method invocation and response.

An Overview of the SOAP v1.1 Specification

SOAP allows business software programs to communicate over the Internet regardless of the platform on which they are based. This article discusses SOAP v1.1 specification topics, including, using XML in SOAP, http as a base transport, and method invocation and response.

by Kennard Scribner and Mark C. Stiver

The SOAP v1.1 Specification

The SOAP specification clearly establishes SOAP's role as a protocol for defining a messaging system as well as remote procedure calls. Although the O in SOAP stands for Object, nothing in the specification suggests that the intention of SOAP is to provide any sort of object or component runtime. To the contrary, SOAP makes no attempt to define mechanisms for object invocation, garbage collection, and so on. SOAP does, however, provide the necessary mechanisms for building object-oriented systems on top of its infrastructure.

HTTP as a Base Transport

Version 1.0 of the specification mandated HTTP as its base transport, but version 1.1 has decoupled SOAP from HTTP to allow SOAP to be used in a messaging paradigm. This leaves the door wide open for a variety of other transports to carry SOAP, such as FTP, SMTP, and others.

Regardless of the transport, there is always some underlying work that must be done to invoke a method on a server. For SOAP as an RPC mechanism, this means constructing a valid HTTP request message.

By default, clients should start by using the POST method; only in the case where this fails with an HTTP status of 405 Method Not Allowed should they attempt the request using M-POST. With the existing Web infrastructure, POST seems to be the reasonable choice at this point and time.

Although it is slightly easier to construct and parse the header fields for a POST than for an M-POST, conforming to M-POST can force clients to provide more detail about the client's request. Consider the examples of POST versus M-POST in Listing 1.

Listing 1 POST Versus M-POST

POST /Script.pl HTTP/1.1
Host: www.mcp.com
Accept: text/*
Content-type: text/xml
Content-length: nnnn
SOAPAction: the-method-uri#DoSomething

M-POST /Script.pl HTTP/1.1
Host: www.mcp.com
Accept: text/*
Content-type: text/xml
Content-length: nnnn
Man: "urn:schemas-xmlsoap-org:soap.v1"; ns=01
01-SOAPAction: the-method-uri#DoSomething


The original SOAP specification v0.9 originally forced M-POST calls to occur before POST calls, thus forcing clients to provide more detail with the first request.

In SOAP v1.0, the specification called for POST calls to occur before M-POST, due to the limited adoption of M-POST.

SOAP recommends that a SOAPAction header field be provided with each SOAP request, such that the server can gather call information without having to parse the entire SOAP payload. At this point, SOAPAction is optional, and clients only have to use it when mandated by the server. However, it is expected that many of you will want to include SOAPAction in your SOAP implementations, so your server can know the intention of the request message.

Using XML in SOAP

One of the simplest aspects of SOAP is that it only requires calls to conform to proper XML syntax. No other XML technologies are required to make SOAP work, although XML Namespaces and XML Schemas make SOAP development much easier.

SOAP recommends the use of namespaces because they provide a mechanism to scope elements and attributes to various contexts. The specification states that clients are able to dictate whether or not namespaces are to be used in a conversation with the server. On the other hand, servers are responsible for ensuring that clients that use namespaces use them correctly. Servers also have the option to process requests that do not contain namespaces or, at a minimum, to respond with a fault.

The namespace 'urn:schemas-xmlsoap-org:soap.v1' is the proposed namespace value for SOAP. This value is simply an URN that should be used to qualify SOAP element and attribute names and does not necessarily reflect any particular resource on the Internet.

SOAP also uses the id/href attribute pairs to distinguish between unique entities within the SOAP payload. This is necessary for providing multi-reference elements in the request and response payloads, such that you serialize the element once and reference it as many times as necessary.

Method Invocation

To execute a SOAP method call, the SOAP payload must be constructed with a <SOAP:Envelope> root element containing an optional <SOAP:Header> element and a mandatory <SOAP:Body> element.

The <SOAP:Header> element is used to encapsulate extended information about the call. The <SOAP:Body> element contains the actual method call (as its first child element) and the associated method parameters as either embedded or independent elements.

Figure 1 shows the basic structure of a SOAP payload.

Figure 1 The basic SOAP payload structure.

Listing 2 shows the basic SOAP structure in use.

Listing 2 Basic SOAP Structure

        <r:RequestNumber xmlns:r="Request-URI">
        <m:GetTemperature xmlns:m="Thermostat-URI">

Here, the header contains a namespace-qualified element called RequestNumber that keeps track of the number of times this request has been made.

The body contains a namespace-qualified method name GetTemperature that contains the city and state parameters.


By qualifying the method name, you are implicitly qualifying its embedded elements so they do not require a namespace prefix.

Method Response

When a method call has been requested, the server has several options. It can return an HTTP error code or a SOAP fault containing a SOAP/application error, or it can return the results of the method execution. Both the fault and the method results use the standard SOAP payload syntax (that is, <Envelope>, <Body>, and so on).

A SOAP fault consists of four elements[md]a faultcode, faultstring, runcode, and an optional detail element, as shown in Listing 3.

Listing 3 SOAP Fault

            <faultstring>Invalid Request</faultstring>


Just as with the <m:GetTemperature> element shown in Listing 3, the <SOAP-ENV:Fault> element does not require its embedded elements to be explicitly qualified because it is an instance of a type.

Any application fault details that need to be included with the fault must be properly typed and qualified using the <detail> element as shown in Listing 4.

Listing 4 Application Fault Details

    <faultstring>Invalid Request</faultstring>
    <detail xmlns:e="GetTemperatureErr-URI"
        <description>Sensor Failure</description>

Notice that the <detail> element uses the XML Schema instance xsi:type attribute to denote its content type, e:GetTemperatureFault, which is also namespace qualified.

Constructing detailed faults in this way allows the client to fully interpret the application fault when necessary.

Representation of Types in the Payload

One of the most difficult aspects of SOAP to understand is the way types are represented in the payload. It's hard to anticipate the many ways parameters can or should be serialized.

SOAP has the capability to serialize any combination of simple and compound types as supported in modern-day programming languages. This is mostly because of SOAP's inclusion of the XML Schema work that is underway to define a standard mechanism for constructing metadata.

SOAP uses the concept of an accessor as the means to acquire a named value in the payload. Named values include parameters as well as named parts of a compound type.

There are two kinds of values in a SOAP payload. The first kind is called a single-reference value and can only be referenced by one accessor. Consider the following XML fragment:


In this case, both the <Car> element and the <Automobile> element contain their own unique Corvette values. This means that each Corvette value has only been referenced by its surrounding element (that is, accessor) and no other.

The second kind of value in a SOAP is called a multi-reference value and can be referenced by one or more accessors. Let's examine a similar XML fragment that uses multi-reference values:

<Car href="#somecar" />
<Automobile id="somecar">Corvette</Automobile>

In this example, Corvette is referenced by two accessors, the Car accessor and the Automobile accessor; thus, it is considered a multi-reference value.

The purpose for distinguishing between single-reference and multi-reference values helps to deal with identity issues of serializing (that is, marshaling) data across the wire. For instance, if two method parameters reference the same value, in some cases you will want the XML to reflect this identity and in other cases you won't.

SOAP also distinguishes between elements that are independent and elements that are embedded. Independent elements are at the highest level of serialization, such as elements contained within SOAP-ENV:Body, and represent instances of types. The name of the independent element is typically the name of the type that it represents. Consider the following XML:

        <m:MyMethod xmlns:m="Method-URI">
            <Car href="#somecar" />
        <Automobile id="somecar">Corvette</Automobile>

In this example, since by definition <SOAP-ENV:Body> is an element that can stand alone, any direct descendants of <SOAP-ENV:Body> are considered independent elements. In this case, <m:MyMethod> is an independent element that describes the method and <Automobile> is an independent element describing an Automobile type.

Embedded elements are anything that's not considered an independent element, and they represent accessors. The name of the embedded element is the same as the name of the accessor that it represents. Referring to the last example, the <Car> element is an embedded element and accessor since the <m:MyMethod> element is an independent element that is at the highest level of the serialization.

The SOAP specification provides a set of rules that define how the preceding constructs should be used to serialize data. It also addresses the more specific procedures that should be followed when serializing particular types such as arrays and strings.

Source: This article is excerpted from Understanding SOAP (http://www.mcp.com/sams/detail_sams.cfm?item=0672319225) by Kennard Scribner and Mark C. Stiver(2000, Sams, ISBN 0672319225). Refer to Chapter 3 of this book for more detailed information on the material covered in this article.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information

To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.


Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.


If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information

Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.


This site is not directed to children under the age of 13.


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information

If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information

Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents

California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure

Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact

Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice

We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020