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 have no namespace.
  • By default, local attribute declarations have no namespace.
Schema Composition

Declared Namespaces

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

Global Declarations

Element: labelResponse

Name labelResponse
Type Locally-defined complex type
Nillable no
Abstract no
Documentation The root XML tag for the data returned from ExpressLabel for the production of routing labels
Diagram
XML Instance Representation
<labelResponse>
<consignment> consignmentResponseType </consignment> [0..5]
<brokenRules> ... </brokenRules> [0..*]
<fault> ... </fault> [0..*]
</labelResponse>
Schema Component Representation
<xsd:element name="labelResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="consignment" type="consignmentResponseType" minOccurs="0" maxOccurs="5"/>
<xsd:element ref="brokenRules" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element ref="fault" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
top

Global Definitions

Attribute Group: renderInstructionsAttributesType

Name renderInstructionsAttributesType
Documentation These are attributes used to determine how and what is displayed for certain fields on the routing Label.
Diagram
XML Instance Representation
code="xsd:string [1] ?"
renderInstructions="xsd:string (value comes from list: {'yes'|'no'|'highlighted'}) [1] ?"
Schema Component Representation
<xsd:attributeGroup name="renderInstructionsAttributesType">
<xsd:attribute name="code" type="xsd:string" use="required"/>
<xsd:attribute name="renderInstructions" use="required">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="yes"/>
<xsd:enumeration value="no"/>
<xsd:enumeration value="highlighted"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
</xsd:attributeGroup>
top

Complex Type: actionDepotType

Super-types: None
Sub-types: None
Name actionDepotType
Abstract no
Documentation Details relevant to an action transit TNT depot.
Diagram
XML Instance Representation
<...>
<depotCode> xsd:string </depotCode> [1] ?
<actionDayOfWeek> xsd:int </actionDayOfWeek> [1] ?
<actionDate> xsd:date </actionDate> [1] ?
</...>
Schema Component Representation
<xsd:complexType name="actionDepotType">
<xsd:sequence>
<xsd:element name="depotCode" type="xsd:string" minOccurs="1"/>
<xsd:element name="actionDayOfWeek" type="xsd:int" minOccurs="1"/>
<xsd:element name="actionDate" type="xsd:date" minOccurs="1"/>
</xsd:sequence>
</xsd:complexType>
top

Complex Type: barcodeType

Super-types: xsd:string < barcodeType (by extension)
Sub-types: None
Name barcodeType
Abstract no
Documentation This contains the information relating to the barcode to be printed on the label.
Diagram
XML Instance Representation
<...
symbology="xsd:string (value comes from list: {'128C'}) [1] ?">
xsd:string
</...>
Schema Component Representation
<xsd:complexType name="barcodeType">
<xsd:simpleContent>
<xsd:extension base="xsd:string">
<xsd:attribute name="symbology" use="required">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="128C"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
top

Complex Type: consignmentResponseType

Super-types: None
Sub-types: None
Name consignmentResponseType
Abstract no
Documentation There is one of these sections per unique consignment within the labels being printed.
Diagram
XML Instance Representation
<...
key="xsd:string [1]">
<pieceLabelData> pieceRoutingLabelType </pieceLabelData> [1..99] ?
<consignmentLabelData> consignmentRoutingLabelType </consignmentLabelData> [1] ?
</...>
Schema Component Representation
<xsd:complexType name="consignmentResponseType">
<xsd:sequence>
<xsd:element name="pieceLabelData" type="pieceRoutingLabelType" minOccurs="1" maxOccurs="99"/>
<xsd:element name="consignmentLabelData" type="consignmentRoutingLabelType" minOccurs="1" maxOccurs="1"/>
</xsd:sequence>
<xsd:attribute name="key" type="xsd:string" use="required"/>
</xsd:complexType>
top

Complex Type: consignmentRoutingLabelType

Super-types: None
Sub-types: None
Name consignmentRoutingLabelType
Abstract no
Documentation There will be one of these sections per consignment, related to 1 or more piece label data sections as appropriate. This XML fragment stores all of the common consignment information for the pieces being labelled.
Diagram
XML Instance Representation
<...>
<consignmentNumber> xsd:string </consignmentNumber> [1] ?
<sender> nameAndAddressResponseType </sender> [1] ?
<delivery> nameAndAddressResponseType </delivery> [1] ?
<contact> contactType </contact> [0..1] ?
<account> accountType </account> [1] ?
<totalNumberOfPieces> xsd:int </totalNumberOfPieces> [1] ?
<product> productDescriptionType </product> [1] ?
<option> optionDescriptionType </option> [0..5]
<collectionDate> xsd:date </collectionDate> [1] ?
<marketDisplay> renderInstructionsType </marketDisplay> [1] ?
<transportDisplay> renderInstructionsType </transportDisplay> [0..1] ?
<freeCirculationDisplay> renderInstructionsType </freeCirculationDisplay> [0..1] ?
<sortSplitText> xsd:string </sortSplitText> [0..1] ?
<xrayDisplay> renderInstructionsType </xrayDisplay> [0..1] ?
<originDepot> depotType </originDepot> [1] ?
<transitDepots> transitDepotListType </transitDepots> [0..1] ?
<destinationDepot> destinationDepotType </destinationDepot> [1] ?
<microzone> renderInstructionsType </microzone> [0..1] ?
<clusterCode> xsd:string </clusterCode> [0..1] ?
<legalComments> xsd:string </legalComments> [0..1] ?
<cashAmount> renderInstructionsType </cashAmount> [0..1] ?
<specialInstructions> xsd:string </specialInstructions> [0..1] ?
<bulkShipment> renderInstructionsType </bulkShipment> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="consignmentRoutingLabelType">
<xsd:sequence>
<xsd:element name="consignmentNumber" type="xsd:string" minOccurs="1"/>
<xsd:element name="sender" type="nameAndAddressResponseType" minOccurs="1"/>
<xsd:element name="delivery" type="nameAndAddressResponseType" minOccurs="1"/>
<xsd:element name="contact" type="contactType" minOccurs="0" maxOccurs="1"/>
<xsd:element name="account" type="accountType" minOccurs="1"/>
<xsd:element name="totalNumberOfPieces" type="xsd:int" minOccurs="1"/>
<xsd:element name="product" type="productDescriptionType" minOccurs="1" maxOccurs="1"/>
<xsd:element name="option" type="optionDescriptionType" maxOccurs="5" minOccurs="0"/>
<xsd:element name="collectionDate" type="xsd:date" minOccurs="1"/>
<xsd:element name="marketDisplay" type="renderInstructionsType" minOccurs="1"/>
<xsd:element name="transportDisplay" type="renderInstructionsType" minOccurs="0"/>
<xsd:element name="freeCirculationDisplay" type="renderInstructionsType" minOccurs="0"/>
<xsd:element name="sortSplitText" type="xsd:string" minOccurs="0"/>
<xsd:element name="xrayDisplay" type="renderInstructionsType" minOccurs="0"/>
<xsd:element name="originDepot" type="depotType" minOccurs="1"/>
<xsd:element name="transitDepots" type="transitDepotListType" minOccurs="0" maxOccurs="1"/>
<xsd:element name="destinationDepot" type="destinationDepotType" minOccurs="1"/>
<xsd:element name="microzone" type="renderInstructionsType" minOccurs="0"/>
<xsd:element name="clusterCode" type="xsd:string" minOccurs="0"/>
<xsd:element name="legalComments" type="xsd:string" minOccurs="0"/>
<xsd:element name="cashAmount" type="renderInstructionsType" minOccurs="0"/>
<xsd:element name="specialInstructions" type="xsd:string" minOccurs="0"/>
<xsd:element name="bulkShipment" type="renderInstructionsType" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Complex Type: destinationDepotType

Super-types: None
Sub-types: None
Name destinationDepotType
Abstract no
Documentation Details relevant to the destination TNT depot.
Diagram
XML Instance Representation
<...>
<depotCode> xsd:string </depotCode> [1] ?
<dueDayOfMonth> xsd:int </dueDayOfMonth> [1] ?
<dueDate> xsd:date </dueDate> [1] ?
</...>
Schema Component Representation
<xsd:complexType name="destinationDepotType">
<xsd:sequence>
<xsd:element name="depotCode" type="xsd:string" minOccurs="1"/>
<xsd:element name="dueDayOfMonth" type="xsd:int" minOccurs="1"/>
<xsd:element name="dueDate" type="xsd:date" minOccurs="1"/>
</xsd:sequence>
</xsd:complexType>
top

Complex Type: numericRenderInstructionsType

Super-types: xsd:double < numericRenderInstructionsType (by extension)
Sub-types: None
Name numericRenderInstructionsType
Abstract no
Documentation These are attributes used to determine how and what is displayed for certain fields on the routing Label. This type contains the display string for the attribute.
Diagram
XML Instance Representation
<...
code="xsd:string [1] ?"
renderInstructions="xsd:string (value comes from list: {'yes'|'no'|'highlighted'}) [1] ?">
xsd:double
</...>
Schema Component Representation
<xsd:complexType name="numericRenderInstructionsType">
<xsd:simpleContent>
<xsd:extension base="xsd:double">
<xsd:attributeGroup ref="renderInstructionsAttributesType"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
top

Complex Type: optionDescriptionType

Super-types: xsd:string < optionDescriptionType (by extension)
Sub-types: None
Name optionDescriptionType
Abstract no
Documentation This contains the information relating to the options to be printed on the label.
Diagram
XML Instance Representation
<...
id="xsd:string [1] ?">
xsd:string
</...>
Schema Component Representation
<xsd:complexType name="optionDescriptionType">
<xsd:simpleContent>
<xsd:extension base="xsd:string">
<xsd:attribute name="id" type="xsd:string" use="required"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
top

Complex Type: pieceRoutingLabelType

Super-types: None
Sub-types: None
Name pieceRoutingLabelType
Abstract no
Documentation Contains information specific to the piece being that a routing label is being created for.
Diagram
XML Instance Representation
<...>
<pieceNumber> xsd:int </pieceNumber> [1] ?
<weightDisplay> renderInstructionsType </weightDisplay> [1]
<pieceReference> xsd:string </pieceReference> [1]
<barcode> barcodeType </barcode> [1]
<barcodeForCustomer> barcodeType </barcodeForCustomer> [0..1]
<twoDBarcode> twoDBarcodeType </twoDBarcode> [0..1]
</...>
Schema Component Representation
<xsd:complexType name="pieceRoutingLabelType">
<xsd:sequence>
<xsd:element name="pieceNumber" type="xsd:int" minOccurs="1"/>
<xsd:element name="weightDisplay" type="renderInstructionsType" minOccurs="1"/>
<xsd:element name="pieceReference" type="xsd:string" minOccurs="1"/>
<xsd:element name="barcode" type="barcodeType" minOccurs="1"/>
<xsd:element name="barcodeForCustomer" type="barcodeType" minOccurs="0"/>
<xsd:element name="twoDBarcode" type="twoDBarcodeType" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Complex Type: productDescriptionType

Super-types: xsd:string < productDescriptionType (by extension)
Sub-types: None
Name productDescriptionType
Abstract no
Documentation This contains the information relating to the product to be printed on the label.
Diagram
XML Instance Representation
<...
id="xsd:string [1] ?">
xsd:string
</...>
Schema Component Representation
<xsd:complexType name="productDescriptionType">
<xsd:simpleContent>
<xsd:extension base="xsd:string">
<xsd:attribute name="id" type="xsd:string" use="required"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
top

Complex Type: renderInstructionsType

Super-types: xsd:string < renderInstructionsType (by extension)
Sub-types: None
Name renderInstructionsType
Abstract no
Documentation These are attributes used to determine how and what is displayed for certain fields on the routing Label. This type contains the display string for the attribute.
Diagram
XML Instance Representation
<...
code="xsd:string [1] ?"
renderInstructions="xsd:string (value comes from list: {'yes'|'no'|'highlighted'}) [1] ?">
xsd:string
</...>
Schema Component Representation
<xsd:complexType name="renderInstructionsType">
<xsd:simpleContent>
<xsd:extension base="xsd:string">
<xsd:attributeGroup ref="renderInstructionsAttributesType"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
top

Complex Type: sortDepotType

Super-types: None
Sub-types: None
Name sortDepotType
Abstract no
Diagram
XML Instance Representation
<...>
<depotCode> xsd:string </depotCode> [1] ?
<sortCellIndicator> renderInstructionsType </sortCellIndicator> [0..1] ?
<sortLocationCode> xsd:string </sortLocationCode> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="sortDepotType">
<xsd:sequence>
<xsd:element name="depotCode" type="xsd:string" minOccurs="1"/>
<xsd:element name="sortCellIndicator" type="renderInstructionsType" minOccurs="0"/>
<xsd:element name="sortLocationCode" type="xsd:string" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Complex Type: transitDepotListType

Super-types: None
Sub-types: None
Name transitDepotListType
Abstract no
Documentation The list of TNT depots that will be handling the consignment between the origin and destination depots.
Diagram
XML Instance Representation
<...>
Start Choice [1..*] ?
<transitDepot> depotType </transitDepot> [0..*] ?
<actionDepot> actionDepotType </actionDepot> [0..*] ?
<sortDepot> sortDepotType </sortDepot> [0..*] ?
End Choice
</...>
Schema Component Representation
<xsd:complexType name="transitDepotListType">
<xsd:choice minOccurs="1" maxOccurs="unbounded">
<xsd:element name="transitDepot" type="depotType" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="actionDepot" type="actionDepotType" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="sortDepot" type="sortDepotType" minOccurs="0" maxOccurs="unbounded"/>
</xsd:choice>
</xsd:complexType>
top

Complex Type: twoDBarcodeType

Super-types: xsd:string < twoDBarcodeType (by extension)
Sub-types: None
Name twoDBarcodeType
Abstract no
Documentation This contains the information relating to the 2D barcode to be printed on the label.
Diagram
XML Instance Representation
<...
symbology="xsd:string (value comes from list: {'pdf417'}) [1] ?">
xsd:string
</...>
Schema Component Representation
<xsd:complexType name="twoDBarcodeType">
<xsd:simpleContent>
<xsd:extension base="xsd:string">
<xsd:attribute name="symbology" use="required">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="pdf417"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
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