This text file contains sample code fragments from:
Section 6.5 - Message Structures
Chapter 6 - Fundamental XML Schema: Types and Message Structure Basics
Book - Web Service Contract Design & Versioning for SOA
Series - Prentice Hall Service-Oriented Computing Series from Thomas Erl
Site - www.soabooks.com


<purchaseOrder version="1.0"
  xmlns="http://actioncon.com/schema/po">
  <poNumber>12345</poNumber>
  <poDate>2006-10-15</poDate>
  <billToPartyID>444403</billToPartyID>
  <billToPartyName>
    MegaEuroMart
  </billToPartyName>
  <billToAddress1>123 Main St.</billToAddress1>
  <billToCity>Cleveland</billToCity>
  <billToState>OH</billToState>
  <billToPostalCode>37311</billToPostalCode>
  <shipToPartyID>444405</shipToPartyID>
  <shipToPartyName>NGS #233</shipToPartyName>
  <shipToAddress1>5100 Garfield Road</shipToAddress1>
  <shipToCity>Cleveland</shipToCity>
  ...
  <lineItem>
    <productID>AY2345</productID>
    ...
  </lineItem>
  <lineItem>
  <productID>BB1764</productID>
  ...
  </lineItem>
</purchaseOrder>

Example 6.29 - The XML document instance for the flat structured input message.


<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns="http://actioncon.com/schema/po"
  targetNamespace="http://actioncon.com/schema/po"
  elementFormDefault="qualified">
  <xsd:element name="purchaseOrder" type="PurchaseOrderType"/>
  <xsd:complexType name="PurchaseOrderType">
    <xsd:sequence>
      <xsd:element name="poNumber" type="xsd:int"/>
      <xsd:element name="poDate" type="xsd:date"/>
      <xsd:element name="billToPartyID" type="xsd:int"/>
      <xsd:element name="billToPartyName" type="xsd:string"/>
      <xsd:element name="billToAddress1" type="xsd:string"/>
      <xsd:element name="billToCity" type="xsd:string"/>
      <xsd:element name="billToState" type="xsd:string"/>
      <xsd:element name="billToPostalCode" type="xsd:string"/>
      <xsd:element name="shipToPartyID" type="xsd:int"/>
      <xsd:element name="shipToPartyName" type="xsd:string"/>
      <xsd:element name="shipToAddress1" type="xsd:string"/>
      <xsd:element name="shipToCity" type="xsd:string"/>
      ...
      <xsd:element name="lineItem" type="LineItemType"
        maxOccurs="unbounded"/>
    </xsd:sequence>
    <xsd:attribute name="version" type="xsd:decimal"/>
  </xsd:complexType>
  <xsd:complexType name="LineItemType">
    <xsd:sequence>
      <xsd:element name="productID" type="ProductIDType"/>
      ...
    </xsd:sequence>
  </xsd:complexType>
</xsd:schema>

Example 6.30 - The XML schema that corresponds to the previous message example.


<purchaseOrder version="1.0"
  xmlns="http://actioncon.com/schema/po">
  ...
  <billToParty>
    <id>444403</id>
    <name>MegaEuroMart</name>
    <address1>123 Main St.</address1>
    <city>Cleveland</city>
    <state>OH</state>
    <postalCode>37311</postalCode>
  </billToParty>
  <shipToParty>
    <id>444405</id>
    <name>NGS #233</name>
    <address1>5100 Garfield Road</address1>
    ...
  </shipToParty>
  ...
</purchaseOrder>

Example 6.31 - A better designed party information structure.


<xsd:complexType name="PurchaseOrderType">
  <xsd:sequence>
    <xsd:element name="poNumber" type="xsd:int"/>
    <xsd:element name="poDate" type="xsd:date"/>
    <xsd:element name="billToParty" type="PartyType"/>
    <xsd:element name="shipToParty" type="PartyType"/>
    <xsd:element name="lineItem" type="LineItemType"
      maxOccurs="unbounded"/>
  </xsd:sequence>
  <xsd:attribute name="version" type="xsd:decimal"/>
</xsd:complexType>
<xsd:complexType name="PartyType">
  <xsd:sequence>
    <xsd:element name="id" type="xsd:int"/>
    <xsd:element name="partyName" type="xsd:string"
      minOccurs="0"/>
    <xsd:element name="contactName" type="xsd:string"
      minOccurs="0"/>
    <xsd:element name="phone" type="xsd:string"
      minOccurs="0"/>
    <xsd:element name="address1" type="xsd:string"/>
    <xsd:element name="city" type="xsd:string"/>
    <xsd:element name="state" type="xsd:string"/>
    <xsd:element name="postalCode" type="xsd:string"/>
  </xsd:sequence>
</xsd:complexType>

Example 6.32 - The PartyType type is reused within the PurchaseOrderType type.


<purchaseOrder version="1.0"
  xmlns="http://actioncon.com/schema/po">
  ...
  <billToParty>
    <id>444403</id>
    <name>MegaEuroMart</name>
    <address>
      <line1>123 Main St.</line1>
      <city>Cleveland</city>
      <state>OH</state>
      <postalCode>37311</postalCode>
    </address>
  </billToParty>
  <shipToParty>
    <id>444405</id>
    <name>NGS #233</name>
    <address>
      <lin1>5100 Garfield Road</line1>
      <city>Cleveland</city>
      ...
    </address>
  </shipToParty>
  ...
</purchaseOrder>

Example 6.33 - Even more structured party information.


<purchaseOrder version="1.0"
  xmlns="http://actioncon.com/schema/po">
  ...
  <lineItems>
    <lineItem>
      <productCode>AY2345</productCode>
      ...
    </lineItem>
    <lineItem>
      <productCode>BB1764</productCode>
      ...
    </lineItem>
  </lineItems>
</purchaseOrder>

Example 6.34 - The lineItems element as a container for repeating lineItem elements.


<purchaseOrder version="1.0"
  xmlns="http://actioncon.com/schema/po">
  <poNumber>12345</poNumber>
  <poDate>2006-10-15</poDate>
  <billToParty>
    <id>444403</id>
    <partyName>MegaEuroMart</partyName>
    <contactName>Steve Smith</contactName>
    <phone>231-555-1122</phone>
    <address>
      <line1>123 Main St.</line1>
      <line2>Suite 300</line2>
      <city>Cleveland</city>
      <state>OH</state>
      <postalCode>37311</postalCode>
      <country>USA</country>
    </address>
  </billToParty>
  <shipToParty>
    <id>444405</id>
    <partyName>NGS #233</partyName>
    <contactName>Steve Smith</contactName>
    <phone>231-555-1122</phone>
    <address>
      <line1>5100 Garfield Road</line1>
      <city>Cleveland</city>
      <state>OH</state>
      <postalCode>37311</postalCode>
      <country>USA</country>
    </address>
  </shipToParty>
  <lineItems>
    <lineItem>
      <productID>AY2345</productID>
      <productName>
        Service Blaster 2000
      </productName>
      <quantity>12</quantity>
      <price>29.99</price>
    </lineItem>
    <lineItem>
      <productID>BB1764</productID>
      <productName>
        Service Blaster 5000 Special Edition
      </productName>
      <quantity>8</quantity>
      <price>19.95</price>
    </lineItem>
  </lineItems>
</purchaseOrder>

Example 6.35 - A sample XML instance of the new Purchase Order message structure.


<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns="http://actioncon.com/schema/po"
  targetNamespace="http://actioncon.com/schema/po"
  elementFormDefault="qualified">
  <xsd:element name="purchaseOrder" type="PurchaseOrderType"/>
  <xsd:complexType name="PurchaseOrderType">
    <xsd:sequence>
      <xsd:element name="poNumber" type="xsd:int"/>
      <xsd:element name="poDate" type="xsd:date"/>
      <xsd:element name="billToParty" type="PartyType"/>
      <xsd:element name="shipToParty" type="PartyType"/>
      <xsd:element name="lineItems" type="LineItemsType"/>
    </xsd:sequence>
    <xsd:attribute name="version" type="xsd:decimal"/>
  </xsd:complexType>
  <xsd:complexType name="PartyType">
    <xsd:sequence>
      <xsd:element name="id" type="xsd:int"/>
      <xsd:element name="partyName" type="xsd:string"
        minOccurs="0"/>
      <xsd:element name="contactName" type="xsd:string"
        minOccurs="0"/>
      <xsd:element name="phone" type="xsd:string"
        minOccurs="0"/>
      <xsd:element name="address" type="AddressType"/>
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="AddressType">
    <xsd:sequence>
      <xsd:element name="line1" type="xsd:string"/>
      <xsd:element name="line2" type="xsd:string"
        minOccurs="0"/>
      <xsd:element name="city" type="xsd:string"/>
      <xsd:element name="state" type="xsd:string"/>
      <xsd:element name="postalCode" type="xsd:string"/>
      <xsd:element name="country" type="xsd:string"/>
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="LineItemsType">
    <xsd:sequence>
      <xsd:element name="lineItem" type="LineItemType"
        maxOccurs="unbounded"/>
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="LineItemType">
    <xsd:sequence>
      <xsd:element name="productID" type="ProductIDType"/>
      <xsd:element name="productName" type="xsd:string"/>
      <xsd:element name="quantity" type="xsd:int"/>
      <xsd:element name="price" type="PriceType"/>
    </xsd:sequence>
  </xsd:complexType>
  <xsd:simpleType name="ProductIDType">
    <xsd:restriction base="xsd:string">
      <xsd:pattern value="[A-Z]{2}[0-9]{4}"/>
    </xsd:restriction>
  </xsd:simpleType>
  <xsd:simpleType name="PriceType">
    <xsd:restriction base="xsd:decimal">
      <xsd:totalDigits value="8"/>
      <xsd:fractionDigits value="2"/>
    </xsd:restriction>
  </xsd:simpleType>
</xsd:schema>

Example 6.36 - The complete schema for the purchase order message.