XML Schema Documentation

Table of Contents

top

Schema Document Properties

Target Namespace None
Element and Attribute Namespaces
  • Global element and attribute declarations belong to this schema's target namespace.
  • By default, local element declarations belong to this schema's target namespace.
  • By default, local attribute declarations have no namespace.
Schema Composition

Declared Namespaces

Prefix Namespace
xml http://www.w3.org/XML/1998/namespace
xs http://www.w3.org/2001/XMLSchema
Schema Component Representation
<xs:schema elementFormDefault="qualified">
<xs:include schemaLocation="commonDefinitions.xsd"/>
...
</xs:schema>
top

Global Declarations

Element: BOOK

Name BOOK
Type Locally-defined complex type
Nillable no
Abstract no
Diagram
XML Instance Representation
<BOOK>
Start Sequence [0..*]
<CONSIGNMENT> ... </CONSIGNMENT> [1]
End Sequence
</BOOK>
Schema Component Representation
<xs:element name="BOOK">
<xs:complexType>
<xs:sequence minOccurs="0" maxOccurs="unbounded">
<xs:element ref="CONSIGNMENT"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: BOOKINGREF

Name BOOKINGREF
Type xs:string
Nillable no
Abstract no
Diagram
XML Instance Representation
<BOOKINGREF> xs:string </BOOKINGREF>
Schema Component Representation
<xs:element name="BOOKINGREF" type="xs:string"/>
top

Element: CONNOTE

Name CONNOTE
Type Locally-defined complex type
Nillable no
Abstract no
Diagram
XML Instance Representation
<CONNOTE>
<!-- Mixed content -->
Start Choice [1]
<ERROR> ... </ERROR> [0..*]
End Choice
</CONNOTE>
Schema Component Representation
<xs:element name="CONNOTE">
<xs:complexType mixed="true">
<xs:choice>
<xs:element ref="ERROR" minOccurs="0" maxOccurs="unbounded"/>
</xs:choice>
</xs:complexType>
</xs:element>
top

Element: CONSIGNMENT

Name CONSIGNMENT
Type Locally-defined complex type
Nillable no
Abstract no
Diagram
XML Instance Representation
<CONSIGNMENT>
<CONREF> ... </CONREF> [1]
<CONNUMBER> ... </CONNUMBER> [1]
<SUCCESS> ... </SUCCESS> [1]
<FIRSTTIMETRADER> ... </FIRSTTIMETRADER> [0..1]
<BOOKINGREF> ... </BOOKINGREF> [0..1]
</CONSIGNMENT>
Schema Component Representation
<xs:element name="CONSIGNMENT">
<xs:complexType>
<xs:sequence>
<xs:element ref="CONREF"/>
<xs:element ref="CONNUMBER"/>
<xs:element ref="SUCCESS"/>
<xs:element ref="FIRSTTIMETRADER" minOccurs="0"/>
<xs:element ref="BOOKINGREF" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: CREATE

Name CREATE
Type Locally-defined complex type
Nillable no
Abstract no
Diagram
XML Instance Representation
<CREATE>
<CONREF> ... </CONREF> [1]
<CONNUMBER> ... </CONNUMBER> [1]
<SUCCESS> ... </SUCCESS> [1]
</CREATE>
Schema Component Representation
<xs:element name="CREATE">
<xs:complexType>
<xs:sequence>
<xs:element ref="CONREF"/>
<xs:element ref="CONNUMBER"/>
<xs:element ref="SUCCESS"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: document

Name document
Type Locally-defined complex type
Nillable no
Abstract no
Diagram
XML Instance Representation
<document>
<GROUPCODE> ... </GROUPCODE> [1]
Start Sequence [0..*]
<CREATE> ... </CREATE> [1]
End Sequence
Start Sequence [0..1]
<RATE> ... </RATE> [1]
End Sequence
Start Sequence [0..1]
<BOOK> ... </BOOK> [1]
End Sequence
Start Sequence [0..1]
<SHIP> ... </SHIP> [1]
End Sequence
<PRINT> ... </PRINT> [1]
<ERROR> ... </ERROR> [1..*]
</document>
Schema Component Representation
<xs:element name="document">
<xs:complexType>
<xs:sequence>
<xs:element ref="GROUPCODE"/>
<xs:sequence minOccurs="0" maxOccurs="unbounded">
<xs:element ref="CREATE"/>
</xs:sequence>
<xs:sequence minOccurs="0">
<xs:element ref="RATE"/>
</xs:sequence>
<xs:sequence minOccurs="0">
<xs:element ref="BOOK"/>
</xs:sequence>
<xs:sequence minOccurs="0">
<xs:element ref="SHIP"/>
</xs:sequence>
<xs:element ref="PRINT"/>
<xs:element ref="ERROR" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: ERROR

Name ERROR
Type Locally-defined complex type
Nillable no
Abstract no
Diagram
XML Instance Representation
<ERROR>
<CODE> xs:string </CODE> [1]
<DESCRIPTION> xs:string </DESCRIPTION> [1]
<SOURCE> xs:string </SOURCE> [1]
</ERROR>
Schema Component Representation
<xs:element name="ERROR">
<xs:complexType>
<xs:sequence>
<xs:element name="CODE" type="xs:string"/>
<xs:element name="DESCRIPTION" type="xs:string"/>
<xs:element name="SOURCE" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: FIRSTTIMETRADER

Name FIRSTTIMETRADER
Type xs:string
Nillable no
Abstract no
Diagram
XML Instance Representation
<FIRSTTIMETRADER> xs:string </FIRSTTIMETRADER>
Schema Component Representation
<xs:element name="FIRSTTIMETRADER" type="xs:string"/>
top

Element: INVOICE

Name INVOICE
Type Locally-defined complex type
Nillable no
Abstract no
Diagram
XML Instance Representation
<INVOICE>
<!-- Mixed content -->
Start Choice [1]
<ERROR> ... </ERROR> [0..*]
End Choice
</INVOICE>
Schema Component Representation
<xs:element name="INVOICE">
<xs:complexType mixed="true">
<xs:choice>
<xs:element ref="ERROR" minOccurs="0" maxOccurs="unbounded"/>
</xs:choice>
</xs:complexType>
</xs:element>
top

Element: LABEL

Name LABEL
Type Locally-defined complex type
Nillable no
Abstract no
Diagram
XML Instance Representation
<LABEL>
<!-- Mixed content -->
Start Choice [1]
<ERROR> ... </ERROR> [0..*]
End Choice
</LABEL>
Schema Component Representation
<xs:element name="LABEL">
<xs:complexType mixed="true">
<xs:choice>
<xs:element ref="ERROR" minOccurs="0" maxOccurs="unbounded"/>
</xs:choice>
</xs:complexType>
</xs:element>
top

Element: MANIFEST

Name MANIFEST
Type Locally-defined complex type
Nillable no
Abstract no
Diagram
XML Instance Representation
<MANIFEST>
<!-- Mixed content -->
Start Choice [1]
<ERROR> ... </ERROR> [0..*]
End Choice
</MANIFEST>
Schema Component Representation
<xs:element name="MANIFEST">
<xs:complexType mixed="true">
<xs:choice>
<xs:element ref="ERROR" minOccurs="0" maxOccurs="unbounded"/>
</xs:choice>
</xs:complexType>
</xs:element>
top

Element: OPTIONDESC

Name OPTIONDESC
Type xs:string
Nillable no
Abstract no
Diagram
XML Instance Representation
<OPTIONDESC> xs:string </OPTIONDESC>
Schema Component Representation
<xs:element name="OPTIONDESC" type="xs:string"/>
top

Element: parse_error

Name parse_error
Type Locally-defined complex type
Nillable no
Abstract no
Diagram
XML Instance Representation
<parse_error>
<error_reason> xs:string </error_reason> [1]
<error_line> xs:string </error_line> [1]
<error_linepos> xs:string </error_linepos> [1]
<error_srcText> xs:string </error_srcText> [1]
</parse_error>
Schema Component Representation
<xs:element name="parse_error">
<xs:complexType>
<xs:sequence>
<xs:element name="error_reason" type="xs:string"/>
<xs:element name="error_line" type="xs:string"/>
<xs:element name="error_linepos" type="xs:string"/>
<xs:element name="error_srcText" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: PRICE

Name PRICE
Type Locally-defined complex type
Nillable no
Abstract no
Diagram
XML Instance Representation
<PRICE>
<RATEID> ... </RATEID> [1]
<SERVICE> ... </SERVICE> [1]
<SERVICEDESC> ... </SERVICEDESC> [1]
<OPTION> ... </OPTION> [1]
<OPTIONDESC> ... </OPTIONDESC> [1]
<CURRENCY> ... </CURRENCY> [1]
<RATE> xs:decimal </RATE> [1]
<RESULT> ... </RESULT> [1]
</PRICE>
Schema Component Representation
<xs:element name="PRICE">
<xs:complexType>
<xs:sequence>
<xs:element ref="RATEID"/>
<xs:element ref="SERVICE"/>
<xs:element ref="SERVICEDESC"/>
<xs:element ref="OPTION"/>
<xs:element ref="OPTIONDESC"/>
<xs:element ref="CURRENCY"/>
<xs:element name="RATE" type="xs:decimal"/>
<xs:element ref="RESULT"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: PRINT

Name PRINT
Type Locally-defined complex type
Nillable no
Abstract no
Diagram
XML Instance Representation
<PRINT>
<ERROR> ... </ERROR> [0..*]
<CONNOTE> ... </CONNOTE> [0..1]
<LABEL> ... </LABEL> [0..1]
<MANIFEST> ... </MANIFEST> [0..1]
<INVOICE> ... </INVOICE> [0..1]
<EMAILTO> xs:string </EMAILTO> [1]
<EMAILFROM> xs:string </EMAILFROM> [1]
</PRINT>
Schema Component Representation
<xs:element name="PRINT">
<xs:complexType>
<xs:sequence>
<xs:element ref="ERROR" minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref="CONNOTE" minOccurs="0"/>
<xs:element ref="LABEL" minOccurs="0"/>
<xs:element ref="MANIFEST" minOccurs="0"/>
<xs:element ref="INVOICE" minOccurs="0"/>
<xs:element name="EMAILTO" type="xs:string"/>
<xs:element name="EMAILFROM" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: RATE

Name RATE
Type Locally-defined complex type
Nillable no
Abstract no
Diagram
XML Instance Representation
<RATE>
Start Sequence [0..*]
<ERROR> ... </ERROR> [1]
End Sequence
Start Sequence [0..*]
<PRICE> ... </PRICE> [1]
End Sequence
</RATE>
Schema Component Representation
<xs:element name="RATE">
<xs:complexType>
<xs:sequence>
<xs:sequence minOccurs="0" maxOccurs="unbounded">
<xs:element ref="ERROR"/>
</xs:sequence>
<xs:sequence minOccurs="0" maxOccurs="unbounded">
<xs:element ref="PRICE"/>
</xs:sequence>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: RATEID

Name RATEID
Type xs:string
Nillable no
Abstract no
Diagram
XML Instance Representation
<RATEID> xs:string </RATEID>
Schema Component Representation
<xs:element name="RATEID" type="xs:string"/>
top

Element: RESULT

Name RESULT
Type xs:string
Nillable no
Abstract no
Diagram
XML Instance Representation
<RESULT> xs:string </RESULT>
Schema Component Representation
<xs:element name="RESULT" type="xs:string"/>
top

Element: runtime_error

Name runtime_error
Type Locally-defined complex type
Nillable no
Abstract no
Diagram
XML Instance Representation
<runtime_error>
<error_reason> xs:string </error_reason> [1]
<error_srcText> xs:string </error_srcText> [1]
</runtime_error>
Schema Component Representation
<xs:element name="runtime_error">
<xs:complexType>
<xs:sequence>
<xs:element name="error_reason" type="xs:string"/>
<xs:element name="error_srcText" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: SERVICEDESC

Name SERVICEDESC
Type xs:string
Nillable no
Abstract no
Diagram
XML Instance Representation
<SERVICEDESC> xs:string </SERVICEDESC>
Schema Component Representation
<xs:element name="SERVICEDESC" type="xs:string"/>
top

Element: SHIP

Name SHIP
Type Locally-defined complex type
Nillable no
Abstract no
Diagram
XML Instance Representation
<SHIP>
Start Sequence [0..*]
<ERROR> ... </ERROR> [1]
End Sequence
Start Sequence [0..*]
<CONSIGNMENT> ... </CONSIGNMENT> [1]
End Sequence
</SHIP>
Schema Component Representation
<xs:element name="SHIP">
<xs:complexType>
<xs:sequence>
<xs:sequence minOccurs="0" maxOccurs="unbounded">
<xs:element ref="ERROR"/>
</xs:sequence>
<xs:sequence minOccurs="0" maxOccurs="unbounded">
<xs:element ref="CONSIGNMENT"/>
</xs:sequence>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: SUCCESS

Name SUCCESS
Type xs:string
Nillable no
Abstract no
Diagram
XML Instance Representation
<SUCCESS> xs:string </SUCCESS>
Schema Component Representation
<xs:element name="SUCCESS" type="xs:string"/>
top

Legend

Complex Type:

Schema Component Type

AusAddress

Schema Component Name
Super-types: Address < AusAddress (by extension)
Sub-types:
  • QLDAddress (by restriction)
If this schema component is a type definition, its type hierarchy is shown in a gray-bordered box.
Name AusAddress
Abstract no
The table above displays the properties of this schema component.
XML Instance Representation
<... country="Australia" >
<unitNo> string </unitNo> [0..1]
<houseNo> string </houseNo> [1]
<street> string </street> [1]
Start Choice [1]
<city> string </city> [1]
<town> string </town> [1]
End Choice
<state> AusStates </state> [1]
<postcode> string <<pattern = [1-9][0-9]{3}>> </postcode> [1] ?
</...>

The XML Instance Representation table above shows the schema component's content as an XML instance.

Schema Component Representation
<complexType name="AusAddress">
<complexContent>
<extension base="Address">
<sequence>
<element name="state" type="AusStates"/>
<element name="postcode">
<simpleType>
<restriction base="string">
<pattern value="[1-9][0-9]{3}"/>
</restriction>
</simpleType>
</element>
</sequence>
<attribute name="country" type="string" fixed="Australia"/>
</extension>
</complexContent>
</complexType>
The Schema Component Representation table above displays the underlying XML representation of the schema component. (Annotations are not shown.)
top

Glossary

Abstract (Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used.

All Model Group Child elements can be provided in any order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-all.

Choice Model Group Only one from the list of child elements and model groups can be provided in instances. See: http://www.w3.org/TR/xmlschema-1/#element-choice.

Collapse Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters.

Disallowed Substitutions (Applies to element declarations). If substitution is specified, then substitution group members cannot be used in place of the given element declaration to validate element instances. If derivation methods, e.g. extension, restriction, are specified, then the given element declaration will not validate element instances that have types derived from the element declaration's type using the specified derivation methods. Normally, element instances can override their declaration's type by specifying an xsi:type attribute.

Key Constraint Like Uniqueness Constraint, but additionally requires that the specified value(s) must be provided. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Key Reference Constraint Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Model Group Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See: http://www.w3.org/TR/xmlschema-1/#Model_Groups.

Nillable (Applies to element declarations). If an element declaration is nillable, instances can use the xsi:nil attribute. The xsi:nil attribute is the boolean attribute, nil, from the http://www.w3.org/2001/XMLSchema-instance namespace. If an element instance has an xsi:nil attribute set to true, it can be left empty, even though its element declaration may have required content.

Notation A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See: http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations.

Preserve Whitespace Policy Preserve whitespaces exactly as they appear in instances.

Prohibited Derivations (Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition.

Prohibited Substitutions (Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition.

Replace Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32).

Sequence Model Group Child elements and model groups must be provided in the specified order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-sequence.

Substitution Group Elements that are members of a substitution group can be used wherever the head element of the substitution group is referenced.

Substitution Group Exclusions (Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element's type using the specified derivation methods.

Target Namespace The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace.

Uniqueness Constraint Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

top

Generated by xs3p (old link) . Last modified: