complexType RouteCostMatrixRequest
diagram routing_p52.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:HistoricTrafficTimeBucket tns:RoadTypePreferences tns:TransientUpdates
used by
element RouteCostMatrixRequest
attributes
Name Type Use Default Fixed Annotation
id xsd:string optional
A unique identifier that is returned in the response. It is used for debugging or keeping track of asynchronous requests.
locale xsd:string optional
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.
description
Route Matrix request.

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

element RouteCostMatrixRequest/StartPoints
diagram routing_p54.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
The spatial reference system name associated with this geometry.
description
The start locations from where to calculate the cost matrix.

element RouteCostMatrixRequest/EndPoints
diagram routing_p55.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
The spatial reference system name associated with this geometry.
description
The end locations to calculate the cost matrix.

element RouteCostMatrixRequest/DistanceUnit
diagram routing_p56.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
The distance unit for: centimeter.
enumeration cm
The distance unit for: centimeter.
enumeration Chain
The distance unit for: chain.
enumeration Foot
The distance unit for: foot.
enumeration ft
The distance unit for: foot.
enumeration Inch
The distance unit for: inch.
enumeration in
The distance unit for: inch.
enumeration Kilometer
The distance unit for: kilometer.
enumeration km
The distance unit for: kilometer.
enumeration Link
The distance unit for: link.
enumeration Meter
The distance unit for: meter.
enumeration m
The distance unit for: meter.
enumeration Mile
The distance unit for: mile.
enumeration mi
The distance unit for: mile.
enumeration Millimeter
The distance unit for: millimeter.
enumeration mm
The distance unit for: millimeter.
enumeration NauticalMile
The distance unit for: nautical mile.
enumeration Pica
The distance unit for: pica.
enumeration Point
The distance unit for: point.
enumeration Rod
The distance unit for: rod.
enumeration SurveyFoot
The distance unit for: survey foot.
enumeration Twip
The distance unit for: twip.
enumeration Yard
The distance unit for: yard.
enumeration yd
The distance unit for: yard.
description
The distance unit to be used during the matrix calculation

element RouteCostMatrixRequest/TimeUnit
diagram routing_p57.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
The time unit for: day.
enumeration Hour
The time unit for: hour.
enumeration Minute
The time unit for: minute.
enumeration Second
The time unit for: second.
enumeration Millisecond
The time unit for: millisecond.
enumeration Week
The time unit for: week.
description
The time unit to be used during the matrix calculation

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

element RouteCostMatrixRequest/OptimizeBy
diagram routing_p59.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
Optimize the matrix calculations using time
enumeration distance
Optimize the matrix calculations using distance

element RouteCostMatrixRequest/MajorRoads
diagram routing_p60.png
namespace http://www.mapinfo.com/routing/service/v1
type xsd:boolean
properties
minOcc 0
maxOcc 1
content simple
default false
description
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_p61.png
namespace http://www.mapinfo.com/routing/service/v1
type xsd:boolean
properties
minOcc 0
maxOcc 1
content simple
default true
description
Whether to return distance in the response or not

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

element RouteCostMatrixRequest/DestinationSrs
diagram routing_p63.png
namespace http://www.mapinfo.com/routing/service/v1
type xsd:string
properties
minOcc 0
maxOcc 1
content simple
description
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/HistoricTrafficTimeBucket
diagram routing_p64.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
No Historic traffic time bucket will be used.
enumeration AMPeak
Historic traffic time bucket for Morning peak hours.
enumeration PMPeak
Historic traffic time bucket for evening peak hours.
enumeration offPeak
Historic traffic time bucket for off peak time.
enumeration night
Historic traffic time bucket for night time.

element RouteCostMatrixRequest/RoadTypePreferences
diagram routing_p65.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_p66.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


© 2017 Pitney Bowes Software Inc. support.pb.com