complexType RouteCostMatrixRequest
diagram routing_p60.png
namespace http://www.mapinfo.com/routing/service/v1
type extension of tns:Request
properties
base midev_common:Request
children tns:DatasetResourceName tns:StartPoints tns:EndPoints tns:DistanceUnit tns:TimeUnit tns:ReturnOptimalRoutesOnly tns:OptimizeBy tns:MajorRoads tns:ReturnDistance tns:ReturnTime tns:DestinationSrs tns:Avoid tns:HistoricTrafficTimeBucket tns:RoadTypePreferences tns:TransientUpdates tns:LocalRoadsLoadFactor
used by
element RouteCostMatrixRequest
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xsd:string  optional      
documentation
A unique identifier that is returned in the response. It is used for debugging or keeping track of asynchronous requests.
locale  xsd:string  optional      
documentation
The language and country code of the request, which is defined using [language_code]_[country_code] syntax. The language code is a 2-letter ISO-639 code. The country code is a 2-letter ISO-3166 code. For example: en_US stands for the English language within the United States of America.
annotation
documentation
Route Matrix request.

element RouteCostMatrixRequest/DatasetResourceName
diagram routing_p61.png
namespace http://www.mapinfo.com/routing/service/v1
type xsd:string
properties
minOcc 0
maxOcc 1
content simple

element RouteCostMatrixRequest/StartPoints
diagram routing_p62.png
namespace http://www.mapinfo.com/routing/service/v1
type tns:MultiPoint
properties
content complex
children tns:Point
attributes
Name  Type  Use  Default  Fixed  Annotation
srsName  xsd:string  optional      
documentation
The spatial reference system name associated with this geometry.
annotation
documentation
The start locations from where to calculate the cost matrix.

element RouteCostMatrixRequest/EndPoints
diagram routing_p63.png
namespace http://www.mapinfo.com/routing/service/v1
type tns:MultiPoint
properties
content complex
children tns:Point
attributes
Name  Type  Use  Default  Fixed  Annotation
srsName  xsd:string  optional      
documentation
The spatial reference system name associated with this geometry.
annotation
documentation
The end locations to calculate the cost matrix.

element RouteCostMatrixRequest/DistanceUnit
diagram routing_p64.png
namespace http://www.mapinfo.com/routing/service/v1
type tns:DistanceUnit
properties
minOcc 0
maxOcc 1
content simple
default Meter
facets
Kind Value Annotation
enumeration Centimeter
documentation
The distance unit for: centimeter.
enumeration cm
documentation
The distance unit for: centimeter.
enumeration Chain
documentation
The distance unit for: chain.
enumeration Foot
documentation
The distance unit for: foot.
enumeration ft
documentation
The distance unit for: foot.
enumeration Inch
documentation
The distance unit for: inch.
enumeration in
documentation
The distance unit for: inch.
enumeration Kilometer
documentation
The distance unit for: kilometer.
enumeration km
documentation
The distance unit for: kilometer.
enumeration Link
documentation
The distance unit for: link.
enumeration Meter
documentation
The distance unit for: meter.
enumeration m
documentation
The distance unit for: meter.
enumeration Mile
documentation
The distance unit for: mile.
enumeration mi
documentation
The distance unit for: mile.
enumeration Millimeter
documentation
The distance unit for: millimeter.
enumeration mm
documentation
The distance unit for: millimeter.
enumeration NauticalMile
documentation
The distance unit for: nautical mile.
enumeration Pica
documentation
The distance unit for: pica.
enumeration Point
documentation
The distance unit for: point.
enumeration Rod
documentation
The distance unit for: rod.
enumeration SurveyFoot
documentation
The distance unit for: survey foot.
enumeration Twip
documentation
The distance unit for: twip.
enumeration Yard
documentation
The distance unit for: yard.
enumeration yd
documentation
The distance unit for: yard.
annotation
documentation
The distance unit to be used during the matrix calculation

element RouteCostMatrixRequest/TimeUnit
diagram routing_p65.png
namespace http://www.mapinfo.com/routing/service/v1
type tns:TimeUnit
properties
minOcc 0
maxOcc 1
content simple
default Minute
facets
Kind Value Annotation
enumeration Day
documentation
The time unit for: day.
enumeration Hour
documentation
The time unit for: hour.
enumeration Minute
documentation
The time unit for: minute.
enumeration Second
documentation
The time unit for: second.
enumeration Millisecond
documentation
The time unit for: millisecond.
enumeration Week
documentation
The time unit for: week.
annotation
documentation
The time unit to be used during the matrix calculation

element RouteCostMatrixRequest/ReturnOptimalRoutesOnly
diagram routing_p66.png
namespace http://www.mapinfo.com/routing/service/v1
type xsd:boolean
properties
content simple
default true
annotation
documentation
Whether to return only optimal routes

element RouteCostMatrixRequest/OptimizeBy
diagram routing_p67.png
namespace http://www.mapinfo.com/routing/service/v1
type tns:optimizeBy
properties
minOcc 0
maxOcc 1
content simple
default time
facets
Kind Value Annotation
enumeration time
documentation
Optimize the matrix calculations using time
enumeration distance
documentation
Optimize the matrix calculations using distance

element RouteCostMatrixRequest/MajorRoads
diagram routing_p68.png
namespace http://www.mapinfo.com/routing/service/v1
type xsd:boolean
properties
minOcc 0
maxOcc 1
content simple
default false
annotation
documentation
Whether to include all roads in the calculation or just major roads. If you choose to include only major roads, performance will improve but accuracy may decrease. The default is true.

element RouteCostMatrixRequest/ReturnDistance
diagram routing_p69.png
namespace http://www.mapinfo.com/routing/service/v1
type xsd:boolean
properties
minOcc 0
maxOcc 1
content simple
default true
annotation
documentation
Whether to return distance in the response or not

element RouteCostMatrixRequest/ReturnTime
diagram routing_p70.png
namespace http://www.mapinfo.com/routing/service/v1
type xsd:boolean
properties
minOcc 0
maxOcc 1
content simple
default true
annotation
documentation
Whether to return time in the response or not

element RouteCostMatrixRequest/DestinationSrs
diagram routing_p71.png
namespace http://www.mapinfo.com/routing/service/v1
type xsd:string
properties
minOcc 0
maxOcc 1
content simple
annotation
documentation
The coordinate system format in which the start, intermediate and end points will be returned. The default is the coordinate system the of the data used. For example: epsg:4326.

element RouteCostMatrixRequest/Avoid
diagram routing_p72.png
namespace http://www.mapinfo.com/routing/service/v1
type xsd:string
properties
minOcc 0
maxOcc 1
content simple
annotation
documentation
This parameters is used to specify comma separated list of road types to be avoided during cost matrix calculation.

element RouteCostMatrixRequest/HistoricTrafficTimeBucket
diagram routing_p73.png
namespace http://www.mapinfo.com/routing/service/v1
type tns:HistoricTrafficTimeBucket
properties
minOcc 0
maxOcc 1
content simple
default none
facets
Kind Value Annotation
enumeration none
documentation
No Historic traffic time bucket will be used.
enumeration AMPeak
documentation
Historic traffic time bucket for Morning peak hours.
enumeration PMPeak
documentation
Historic traffic time bucket for evening peak hours.
enumeration offPeak
documentation
Historic traffic time bucket for off peak time.
enumeration night
documentation
Historic traffic time bucket for night time.

element RouteCostMatrixRequest/RoadTypePreferences
diagram routing_p74.png
namespace http://www.mapinfo.com/routing/service/v1
type tns:RoadTypesPrefMap
properties
minOcc 0
maxOcc 1
content complex
children tns:RoadTypesPrefEntry

element RouteCostMatrixRequest/TransientUpdates
diagram routing_p75.png
namespace http://www.mapinfo.com/routing/service/v1
type tns:TransientUpdates
properties
minOcc 0
maxOcc 1
content complex
children tns:PointUpdateList tns:SegmentUpdateList tns:RoadTypeUpdateList

element RouteCostMatrixRequest/LocalRoadsLoadFactor
diagram routing_p76.png
namespace http://www.mapinfo.com/routing/service/v1
type xsd:int
properties
minOcc 0
maxOcc 1
content simple
default 1


© 2007, 2020 Precisely. All rights reserved. support.precisely.com