This text file contains sample code fragments from:
Section 13.4 - Incorporating Industry Schemas
Chapter 13 - Advanced XML Schema Part II: Reusability, Relational Design, and Industry Schemas
Book - Web Service Contract Design & Versioning for SOA
Series - Prentice Hall Service-Oriented Computing Series from Thomas Erl
Site - www.soabooks.com


<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns="http://my-vocabulary.org"
  xmlns:std="http://standard.org"
  targetNamespace="http://my-vocabulary.org">
  <xsd:import namespace="http://standard.org"
    schemaLocation="http://standard.org/standard.xsd"/>
  <xsd:complexType name="MyNewType">
    <xsd:sequence>
      <xsd:element name="myVocabulary1" type="xsd:string"/>
      <xsd:element ref="std:standardVocabulary1"/>
      <xsd:element ref="std:standardVocabulary2"/>
      <xsd:element name="myVocabulary2" type="xsd:string"/>
    </xsd:sequence>
  </xsd:complexType>
  ...
</xsd:schema>

Example 13.16 - A custom schema referring to elements from an industry schema (in another namespace).


<xsd:schema version="2.2"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:eg=
    "urn:ean.ucc:align:entertainment:electronic_games:2"
  attributeFormDefault="unqualified"
  elementFormDefault="unqualified"
  targetNamespace=
    "urn:ean.ucc:align:entertainment:electronic_games:2">
  <xsd:annotation>
    <xsd:documentation>
---------------------------
Copyright GS1, 2007 GS1 is providing this XML Schema Definition file and resultant XML
file as a service to interested industries. This XML Schema Definition file and resultant
XML file were developed through a consensus process of interested parties. Although
efforts have been made to ensure that the XML Schema Definition file and resultant XML
file are correct, reliable, and technically accurate, GS1 makes NO WARRANTY, EXPRESS OR
IMPLIED, THAT THIS XML Schema Definition file and resultant XML file ARE CORRECT, WILL NOT
REQUIRE MODIFICATION AS EXPERIENCE AND TECHNOLOGICAL ADVANCES DICTATE, OR WILL BE SUITABLE
FOR ANY PURPOSE OR WORKABLE IN ANY APPLICATION, OR OTHERWISE. Use of the XML Schema Definition
file and resultant XML file are with the understanding that GS1 has no liability for
any claim to the contrary, or for any damage or loss of any kind or nature.
Version Information: Version Number: 2.2 Date of creation: August 2007
The schema and subsequent updates will be provided on the GS1 websites.
---------------------------
    </xsd:documentation>
  </xsd:annotation>
  <xsd:complexType name="ElectronicGamePlayerInformationType">
    <xsd:sequence>
      <xsd:element name="ageRangeDescription" minOccurs="0">
        <xsd:simpleType>
          <xsd:restriction base="xsd:string">
            <xsd:maxLength value="35"/>
            <xsd:minLength value="1"/>
          </xsd:restriction>
        </xsd:simpleType>
      </xsd:element>
      <xsd:element name="maximumNumberOfPlayers"
        type="xsd:integer" minOccurs="0"/>
      <xsd:element name="maximumPlayerAge"
        type="xsd:integer" minOccurs="0"/>
      <xsd:element name="minimumNumberOfPlayers"
        type="xsd:integer" minOccurs="0"/>
      <xsd:element name="minimumPlayerAge"
        type="xsd:integer" minOccurs="0"/>
    </xsd:sequence>
  </xsd:complexType>
</xsd:schema>

Example 13.17 - The contents of the GS1 ElectronicGamePlayerInformation.xsd schema.


<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  targetNamespace="http://actioncon.com/schema/gameinfo"
  xmlns="http://actioncon.com/schema/gameinfo"
  xmlns:common="http://actioncon.com/schema/common"
  xmlns:eg="urn:ean.ucc:align:entertainment:electronic_games:2"
  elementFormDefault="qualified">
  <xsd:import namespace=
    "urn:ean.ucc:align:entertainment:electronic_games:2"
    schemaLocation="ElectronicGamePlayerInformation.xsd"/>
  <xsd:import namespace="http://actioncon.com/schema/common"
    schemaLocation=
      "http://actioncon.com/schema/common.xsd"/>
  <xsd:complexType name="GameType">
    <xsd:sequence>
      <xsd:element name="productID"
        type="common:ProductIDType"/>
      <xsd:element name="gtin" type="GTINType"/>
      ...
      <xsd:element name="playerInformation"
        type="eg:ElectronicGamePlayerInformationType"/>
    </xsd:sequence>
  </xsd:complexType>
  ...
</xsd:schema>

Example 13.18 - The GameType construct using a GS1 standard type.


<game:game xmlns:game="http://actioncon.com/gameinfo">
  <game:productID>AY2344</game:productID>
  <game:gtin>1234567890123</game:gtin>
  ...
  <game:playerInformation>
    <maximumNumberOfPlayers>2</maximumNumberOfPlayers>
    <maximumPlayerAge>15</maximumPlayerAge>
    <minimumNumberOfPlayers>1</minimumNumberOfPlayers>
    <minimumPlayerAge>10</minimumPlayerAge>
  </game:playerInformation>
</game:game>

Example 13.19 - An instance of the Game type that uses GS1 elements.


<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns="urn:oasis:names:specification:
  ubl:schema:xs:CommonExtensionComponents-2"
  xmlns:cbc="urn:oasis:names:specification:
  ubl:schema:xs:CommonBasicComponents-2"
  targetNamespace="urn:oasis:names:specification:
  ubl:schema:xs:CommonExtensionComponents-2"
  elementFormDefault="qualified"
  attributeFormDefault="unqualified" version="2.0">
  ...
  <xsd:element name="UBLExtensions" type="UBLExtensionsType"/>
  <xsd:complexType name="UBLExtensionsType">
    <xsd:sequence>
      <xsd:element ref="UBLExtension" minOccurs="1"
        maxOccurs="unbounded"/>
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="UBLExtension" type="UBLExtensionType"/>
  <xsd:complexType name="UBLExtensionType">
    <xsd:sequence>
      <xsd:element ref="cbc:ID" minOccurs="0"
        maxOccurs="1"/>
      <xsd:element ref="cbc:Name" minOccurs="0"
        maxOccurs="1"/>
      <xsd:element ref="ExtensionAgencyID" minOccurs="0"
        maxOccurs="1"/>
      <xsd:element ref="ExtensionAgencyName" minOccurs="0"
        maxOccurs="1"/>
      <xsd:element ref="ExtensionVersionID" minOccurs="0"
        maxOccurs="1"/>
      <xsd:element ref="ExtensionAgencyURI" minOccurs="0"
        maxOccurs="1"/>
      <xsd:element ref="ExtensionURI" minOccurs="0"
        maxOccurs="1"/>t
      <xsd:element ref="ExtensionReasonCode" minOccurs="0"
        maxOccurs="1"/>
      <xsd:element ref="ExtensionReason" minOccurs="0"
        maxOccurs="1"/>
      <xsd:element ref="ExtensionContent" minOccurs="1"
        maxOccurs="1"/>
    </xsd:sequence>
  </xsd:complexType>
</xsd:schema>

Example 13.20 - A UBL 2.0 schema containing extension definitions. Some schema annotations have been removed for brevity.


<xsd:complexType name="ExtensionContentType">
  <xsd:sequence>
    <xsd:any namespace="##any" minOccurs="0" maxOccurs="1"
      processContents="skip"/>
  </xsd:sequence>
</xsd:complexType>
<xsd:element name="ExtensionContent" type="ExtensionContentType"/>

Example 13.21 - The UBL ExtensionContentType complex type and the ExtensionContent global element.


<Order xmlns:cbc="urn:oasis:names:specification:
  ubl:schema:xs:CommonBasicComponents-2"
    xmlns:cac="urn:oasis:names:specification:
  ubl:schema:xs:CommonAggregateComponents-2"
    xmlns="urn:oasis:names:specification:
  ubl:schema:xs:Order-2">
  <cbc:UBLVersionID>
    2.0
  </cbc:UBLVersionID>
  <cbc:CustomizationID>
    urn:oasis:names:specification:
    ubl:xpath:Order-2.0:sbs-1.0-draft
  </cbc:CustomizationID>
  <cbc:ProfileID>
    bpid:urn:oasis:names:draft:bpss:
    ubl-2-sbs-order-with-simple-response-draft
  </cbc:ProfileID>
  <cbc:ID>
    12345
  </cbc:ID>
  <cbc:IssueDate>
    2006-10-15
  </cbc:IssueDate>
  <cac:BuyerCustomerParty>
    <cbc:CustomerAssignedAccountID>
      444403
    </cbc:CustomerAssignedAccountID>
    <cac:Party>
      <cac:PartyName>
        <cbc:Name>Neighborhood Game Stores, Inc.</cbc:Name>
      </cac:PartyName>
      <cac:PostalAddress>
        <cbc:Room>300</cbc:Room>
        <cbc:StreetName>Main St.</cbc:StreetName>
        <cbc:BuildingNumber>123</cbc:BuildingNumber>
        <cbc:CityName>Cleveland</cbc:CityName>
        <cbc:PostalZone>37311</cbc:PostalZone>
        <cbc:CountrySubentity>OH</cbc:CountrySubentity>
        <cac:Country>
          <cbc:IdentificationCode>US</cbc:IdentificationCode>
        </cac:Country>
      </cac:PostalAddress>
      <cac:Contact>
        <cbc:Name>Steve Smith</cbc:Name>
        <cbc:Telephone>231-555-1122</cbc:Telephone>
      </cac:Contact>
    </cac:Party>
  </cac:BuyerCustomerParty>
  <cac:Delivery>
    <cac:DeliveryAddress>
      <cbc:StreetName>5100 Garfield Road</cbc:StreetName>
      <cbc:CityName>Traverse City</cbc:CityName>
      <cbc:PostalZone>49686</cbc:PostalZone>
      <cbc:CountrySubentity>MI</cbc:CountrySubentity>
      <cac:Country>
      <cbc:IdentificationCode>US</cbc:IdentificationCode>
      <cac:Country>
    </cac:DeliveryAddress>
  </cac:Delivery>
  <cac:OrderLine>
    <cac:LineItem>
      <cbc:ID>1</cbc:ID>
      <cbc:Quantity unitCode="EA">12</cbc:Quantity>
      <cac:Price>
        <cbc:PriceAmount currencyID="USD">
          29.99
        </cbc:PriceAmount>
      </cac:Price>
      <cac:Item>
        <cbc:Name>Service Blaster 2000</cbc:Name>
        <cac:SellersItemIdentification>
          <cbc:ID>AY2345</cbc:ID>
        </cac:SellersItemIdentification>
      </cac:Item>
    </cac:LineItem>
  </cac:OrderLine>
  <cac:OrderLine>
    <cac:LineItem>
      <cbc:ID>2</cbc:ID>
      <cbc:Quantity unitCode="EA">8</cbc:Quantity>
      <cac:Price>
        <cbc:PriceAmount currencyID="USD">
          19.95
        </cbc:PriceAmount>
      </cac:Price>
      <cac:Item>
        <cbc:Name>
          Extreme Composition - Special Edition
        </cbc:Name>
        <cac:SellersItemIdentification>
          <cbc:ID>BB1764</cbc:ID>
        </cac:SellersItemIdentification>
      </cac:Item>
    </cac:LineItem>
  </cac:OrderLine>
</Order>

Example 13.22 - A purchase order document instance expressed with UBL 2.0.


<Order xmlns:cbc="urn:oasis:names:specification:
  ubl:schema:xs:CommonBasicComponents-2"
  xmlns:cac="urn:oasis:names:specification:
    ubl:schema:xs:CommonAggregateComponents-2"
  xmlns:ext="urn:oasis:names:specification:
    ubl:schema:xs:CommonExtensionComponents-2"
  xmlns:mmo="http://megaeuromart.com/order"
  xmlns="urn:oasis:names:specification:
    ubl:schema:xs:Order-2">
  <ext:UBLExtensions>
    <ext:UBLExtension>
      <ext:ExtensionContent>
        <mmo:PricingTerms>
          <mmo:PriceInfo>
            <mmo:LineItemID>1</mmo:LineItemID>
            <mmo:QuantityYearToDate unitCode="EA">
              255
            </mmo:QuantityYearToDate>
            <mmo:PriceTier>2</mmo:PriceTier>
          </mmo:PriceInfo>
          <mmo:PriceInfo>
            <mmo:LineItemID>2</mmo:LineItemID>
            <mmo:QuantityYearToDate unitCode="EA">
              415
            </mmo:QuantityYearToDate>
            <mmo:PriceTier>3</mmo:PriceTier>
          </mmo:PriceInfo>
        </mmo:PricingTerms>
      </ext:ExtensionContent>
    </ext:UBLExtension>
  </ext:UBLExtensions>
  <cbc:UBLVersionID>2.0</cbc:UBLVersionID>
...

Example 13.23 - An XML purchase order document instance containing a mix of UBL and custom elements. The UBL elements appear either with no prefix or the cac:, cbc:, or ext: prefixes (mapped to UBL namespaces). The custom elements appear with the mmo: prefix.


<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns="http://megaeuromart.com/order"
  targetNamespace="http://megaeuromart.com/order"
  xmlns:udt="urn:un:unece:uncefact:data:
    specification:
    UnqualifiedDataTypesSchemaModule:2">
  <xsd:import namespace="urn:un:unece:uncefact:data:
    specification:UnqualifiedDataTypesSchemaModule:2"/>
  <xsd:element name="PriceInfo" type="PriceInfoType"/>
  <xsd:element name="PriceTier" type="udt:NumericType"/>
  <xsd:element name="PricingTerms" type="PricingTermsType"/>
  <xsd:element name="LineItemID" type="udt:IdentifierType"/>
  <xsd:element name="QuantityYearToDate"
    type="udt:QuantityType"/>
  <xsd:complexType name="PriceInfoType">
    <xsd:sequence>
      <xsd:element ref="LineItemID"/>
      <xsd:element ref="QuantityYearToDate"/>
      <xsd:element ref="PriceTier"/>
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="PricingTermsType">
    <xsd:sequence>
      <xsd:element ref="PriceInfo" minOccurs="0"
        maxOccurs="unbounded"/>
    </xsd:sequence>
  </xsd:complexType>
</xsd:schema>

Example 13.24 - The MegaEuroMart schema declaring custom purchase order elements.