Documentation for route_1.2

Table of Contents

Master schema documentation file: route_1.2.xsd.html

top

Schema Document Properties

Target Namespace http://clients.multimap.com/API
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.

Declared Namespaces

Prefix Namespace
Default namespace http://clients.multimap.com/API
xml http://www.w3.org/XML/1998/namespace
xs http://www.w3.org/2001/XMLSchema
Schema Component Representation
<xs:schema targetNamespace="http://clients.multimap.com/API" elementFormDefault="qualified">
...
</xs:schema>
top

Global Definitions

Complex Type: AddressType

Super-types: None
Sub-types: None
Name AddressType
Used by (from the same schema document) Complex Type LocationType , Model Group AddressLocationGroup
Abstract no
XML Instance Representation
<...>
<Street> xs:string </Street> [0..1]
Start Choice [0..1]
<City> xs:string </City> [1]
<Areas> AreasType </Areas> [1]
End Choice
Start Choice [0..1]
<Region> xs:string </Region> [1]
<State> xs:string </State> [1]
End Choice
Start Choice [0..1]
<PostalCode> xs:string </PostalCode> [1]
<ZIP> xs:string </ZIP> [1]
End Choice
<DisplayName> xs:string </DisplayName> [0..1]
<CountryCode> xs:string </CountryCode> [0..1]
<qs> xs:string </qs> [0..1]
</...>
Diagram
h1243577083
Schema Component Representation
<xs:complexType name="AddressType">
<xs:sequence>
<xs:element name="Street" type=" xs:string " minOccurs="0"/>
<xs:choice minOccurs="0">
<xs:element name="City" type=" xs:string "/>
<xs:element name="Areas" type=" AreasType " form="qualified"/>
</xs:choice>
<xs:choice minOccurs="0">
<xs:element name="Region" type=" xs:string "/>
<xs:element name="State" type=" xs:string "/>
</xs:choice>
<xs:choice minOccurs="0">
<xs:element name="PostalCode" type=" xs:string "/>
<xs:element name="ZIP" type=" xs:string "/>
</xs:choice>
<xs:element name="DisplayName" type=" xs:string " minOccurs="0"/>
<xs:element name="CountryCode" type=" xs:string " minOccurs="0"/>
<xs:element name="qs" type=" xs:string " minOccurs="0"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: AreasType

Super-types: None
Sub-types: None
Name AreasType
Used by (from the same schema document) Complex Type AddressType
Abstract no
XML Instance Representation
<...>
<Area> xs:string </Area> [1..*]
</...>
Diagram
Schema Component Representation
<xs:complexType name="AreasType">
<xs:sequence>
<xs:element name="Area" type=" xs:string " maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: BoundsType

Super-types: None
Sub-types: None
Name BoundsType
Abstract no
XML Instance Representation
<...>
<NorthEast> PointType </NorthEast> [1]
<SouthWest> PointType </SouthWest> [1]
</...>
Diagram
h-1403749883 h-1403749883
Schema Component Representation
<xs:complexType name="BoundsType">
<xs:sequence>
<xs:element name="NorthEast" type=" PointType " form="qualified"/>
<xs:element name="SouthWest" type=" PointType " form="qualified"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: DistanceType

Super-types: None
Sub-types: None
Name DistanceType
Used by (from the same schema document) Model Group RecordSetNormalGroup
Abstract no
XML Instance Representation
<...>
<Miles> xs:float </Miles> [1]
<KM> xs:float </KM> [1]
</...>
Diagram
Schema Component Representation
<xs:complexType name="DistanceType">
<xs:sequence>
<xs:element name="Miles" type=" xs:float "/>
<xs:element name="KM" type=" xs:float "/>
</xs:sequence>
</xs:complexType>
top

Complex Type: DurationType

Super-types: None
Sub-types: None
Name DurationType
Abstract no
XML Instance Representation
<...>
<Days> xs:int </Days> [0..1]
<Hours> xs:int </Hours> [0..1]
<Minutes> xs:int </Minutes> [1]
</...>
Diagram
Schema Component Representation
<xs:complexType name="DurationType">
<xs:sequence>
<xs:element name="Days" type=" xs:int " minOccurs="0"/>
<xs:element name="Hours" type=" xs:int " minOccurs="0"/>
<xs:element name="Minutes" type=" xs:int "/>
</xs:sequence>
</xs:complexType>
top

Complex Type: ErrorType

Super-types: None
Sub-types: None
Name ErrorType
Used by (from the same schema document) Complex Type RecordSetType
Abstract no
XML Instance Representation
<...>
<ErrorCode> ... </ErrorCode> [1]
<Explanation> ... </Explanation> [0..1]
</...>
Diagram
h739098423
Schema Component Representation
<xs:complexType name="ErrorType">
<xs:sequence>
<xs:group ref=" ErrorGroup "/>
</xs:sequence>
</xs:complexType>
top

Complex Type: LocationsType

Super-types: None
Sub-types: None
Name LocationsType
Used by (from the same schema document) Model Group AddressLocationGroup
Abstract no
XML Instance Representation
<...>
<Location> LocationType </Location> [2..*]
</...>
Diagram
h542834068
Schema Component Representation
<xs:complexType name="LocationsType">
<xs:sequence>
<xs:element name="Location" type=" LocationType " minOccurs="2" maxOccurs="unbounded" form="qualified"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: LocationType

Super-types: None
Sub-types: None
Name LocationType
Used by (from the same schema document) Complex Type LocationsType
Abstract no
XML Instance Representation
<...
geocodeQuality=" xs:string [0..1]"
geocodeScore=" xs:decimal [0..1]"
zoomFactor=" xs:int [0..1]">
<Address> AddressType </Address> [1]
<Point> PointType </Point> [1]
</...>
Diagram
h-2050616407 h-1403749883
Schema Component Representation
<xs:complexType name="LocationType">
<xs:sequence>
<xs:element name="Address" type=" AddressType " form="qualified"/>
<xs:element name="Point" type=" PointType " form="qualified"/>
</xs:sequence>
<xs:attribute name="geocodeQuality" type=" xs:string " use="optional"/>
<xs:attribute name="geocodeScore" type=" xs:decimal " use="optional"/>
<xs:attribute name="zoomFactor" type=" xs:int " use="optional"/>
</xs:complexType>
top

Complex Type: PointType

Super-types: None
Sub-types: None
Name PointType
Used by (from the same schema document) Complex Type LocationType , Complex Type BoundsType , Complex Type BoundsType , Model Group RecordSetNormalGroup
Abstract no
XML Instance Representation
<...>
<Lat> xs:decimal </Lat> [1]
<Lon> xs:decimal </Lon> [1]
</...>
Diagram
Schema Component Representation
<xs:complexType name="PointType">
<xs:sequence>
<xs:element name="Lat" type=" xs:decimal "/>
<xs:element name="Lon" type=" xs:decimal "/>
</xs:sequence>
</xs:complexType>
top

Complex Type: PreFlightErrorType

Super-types: None
Sub-types: None
Name PreFlightErrorType
Used by (from the same schema document) Complex Type RecordSetsType
Abstract no
XML Instance Representation
<...
inputID="anySimpleType [0..1]"
errorCode="anySimpleType [0..1]"
action="anySimpleType [0..1]">
Start Sequence [0..1]
Start Choice [1]
<RecordSet> RecordSetType </RecordSet> [1]
<Address> AddressType </Address> [1]
<Locations> LocationsType </Locations> [1]
<ErrorCode> ... </ErrorCode> [1]
<Explanation> ... </Explanation> [0..1]
End Choice
End Sequence
</...>
Diagram
h-1973157690 h-1043644906 h739098423
Schema Component Representation
<xs:complexType name="PreFlightErrorType">
<xs:sequence minOccurs="0" maxOccurs="1">
<xs:choice>
<xs:element name="RecordSet" type=" RecordSetType " form="qualified"/>
<xs:group ref=" AddressLocationGroup "/>
<xs:group ref=" ErrorGroup "/>
</xs:choice>
</xs:sequence>
<xs:attribute name="inputID" use="optional"/>
<xs:attribute name="errorCode" use="optional"/>
<xs:attribute name="action" use="optional"/>
</xs:complexType>
top

Complex Type: RecordSetsType

Super-types: None
Sub-types: None
Name RecordSetsType
Abstract no
XML Instance Representation
<...>
Start Choice [1..*]
<RecordSet> RecordSetType </RecordSet> [1]
Start Choice [1]
<Error> PreFlightErrorType </Error> [1]
End Choice
End Choice
</...>
Diagram
h-1973157690 h1149491956
Schema Component Representation
<xs:complexType name="RecordSetsType">
<xs:sequence>
<xs:choice maxOccurs="unbounded">
<xs:element name="RecordSet" type=" RecordSetType " form="qualified"/>
<xs:choice>
<xs:element name="Error" type=" PreFlightErrorType " form="qualified"/>
</xs:choice>
</xs:choice>
</xs:sequence>
</xs:complexType>
top

Complex Type: RecordSetType

Super-types: None
Sub-types: None
Name RecordSetType
Used by (from the same schema document) Complex Type RecordSetsType , Complex Type PreFlightErrorType
Abstract no
XML Instance Representation
<...
dataSource="anySimpleType [1]"
totalRecordCount="anySimpleType [0..1]">
Start Choice [1]
<Information> [0..1]
<Info
name="anySimpleType [1]"> [1..*]
xs:string
</Info>
</Information>
<Record
counter="anySimpleType [1]"> [0..*]
<Fields> [0..1]
<Field
name="anySimpleType [1]"> [1..*]
xs:string
</Field>
</Fields>
<Distance> DistanceType </Distance> [0..1]
<Point> PointType </Point> [0..1]
</Record>
<Error> ErrorType </Error> [1]
End Choice
</...>
Diagram
h1425637543 h1656224381
Schema Component Representation
<xs:complexType name="RecordSetType">
<xs:sequence>
<xs:choice>
<xs:group ref=" RecordSetNormalGroup "/>
<xs:element name="Error" type=" ErrorType " form="qualified"/>
</xs:choice>
</xs:sequence>
<xs:attribute name="dataSource" use="required"/>
<xs:attribute name="totalRecordCount" use="optional"/>
</xs:complexType>
top

Model Group: AddressLocationGroup

Name AddressLocationGroup
Used by (from the same schema document) Complex Type PreFlightErrorType
XML Instance Representation
<Address> AddressType </Address> [1]
<Locations> LocationsType </Locations> [1]
Diagram
h-2050616407 h-324477101
Schema Component Representation
<xs:group name="AddressLocationGroup">
<xs:sequence>
<xs:element name="Address" type=" AddressType " form="qualified"/>
<xs:element name="Locations" type=" LocationsType " form="qualified" minOccurs="1" maxOccurs="1"/>
</xs:sequence>
</xs:group>
top

Model Group: ErrorGroup

Name ErrorGroup
Used by (from the same schema document) Complex Type ErrorType , Complex Type PreFlightErrorType
XML Instance Representation
<ErrorCode> ... </ErrorCode> [1]
<Explanation> ... </Explanation> [0..1]
Diagram
Schema Component Representation
<xs:group name="ErrorGroup">
<xs:sequence>
<xs:element name="ErrorCode" form="qualified"/>
<xs:element name="Explanation" minOccurs="0" maxOccurs="1" form="qualified"/>
</xs:sequence>
</xs:group>
top

Model Group: RecordSetNormalGroup

Name RecordSetNormalGroup
Used by (from the same schema document) Complex Type RecordSetType
XML Instance Representation
<Information> [0..1]
<Info
name="anySimpleType [1]"> [1..*]
xs:string
</Info>
</Information>
<Record
counter="anySimpleType [1]"> [0..*]
<Fields> [0..1]
<Field
name="anySimpleType [1]"> [1..*]
xs:string
</Field>
</Fields>
<Distance> DistanceType </Distance> [0..1]
<Point> PointType </Point> [0..1]
</Record>
Diagram
h-387135020 h-1403749883
Schema Component Representation
<xs:group name="RecordSetNormalGroup">
<xs:sequence>
<xs:element name="Information" minOccurs="0" maxOccurs="1" form="qualified">
<xs:complexType>
<xs:sequence>
<xs:element name="Info" minOccurs="1" maxOccurs="unbounded" form="qualified">
<xs:complexType>
<xs:simpleContent>
<xs:extension base=" xs:string ">
<xs:attribute name="name" use="required"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="Record" minOccurs="0" maxOccurs="unbounded" form="qualified">
<xs:complexType>
<xs:sequence>
<xs:element name="Fields" minOccurs="0" maxOccurs="1" form="qualified">
<xs:complexType>
<xs:sequence>
<xs:element name="Field" minOccurs="1" maxOccurs="unbounded" form="qualified">
<xs:complexType>
<xs:simpleContent>
<xs:extension base=" xs:string ">
<xs:attribute name="name" use="required"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="Distance" type=" DistanceType " minOccurs="0" form="qualified"/>
<xs:element name="Point" type=" PointType " minOccurs="0" form="qualified"/>
</xs:sequence>
<xs:attribute name="counter" use="required"/>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:group>
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