Documentation for route_1.2

Schema Document Properties
Global Definitions

Legend

Glossary

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

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

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

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

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

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

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

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: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

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

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

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.

The minimum and maximum occurrence of elements and attributes are provided in square brackets, e.g. [0..1].
Model group information are shown in gray, e.g. Start Choice ... End Choice.
For type derivations, the elements and attributes that have been added to or changed from the base type's content are shown in bold.
If an element/attribute has a fixed value, the fixed value is shown in green, e.g. country="Australia".
Otherwise, the type of the element/attribute is displayed.
- If the element/attribute's type is in the schema, a link is provided to it.
- For local simple type definitions, the constraints are displayed in angle brackets, e.g. <<pattern = [1-9][0-9]{3}>>.
If a local element/attribute has documentation, it will be displayed in a window that pops up when the question mark inside the attribute or next to the element is clicked, e.g. <postcode>.

Schema Component Representation

Documentation for route_1.2

Table of Contents

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

Schema Document Properties

Declared Namespaces

Global Definitions

Complex Type: AddressType

Complex Type: AreasType

Complex Type: BoundsType

Complex Type: DistanceType

Complex Type: DurationType

Complex Type: ErrorType

Complex Type: LocationsType

Complex Type: LocationType

Complex Type: PointType

Complex Type: PreFlightErrorType

Complex Type: RecordSetsType

Complex Type: RecordSetType

Model Group: AddressLocationGroup

Model Group: ErrorGroup

Model Group: RecordSetNormalGroup

Legend

Complex Type:

AusAddress