Share via

RouteRequestRouteMatrixSyncQueryParamProperties interface

  • Reference
Package:
@azure-rest/maps-route

Properties

arriveAt

The date and time of arrival at the destination point formatted as a dateTime value as defined in RFC 3339, section 5.6, with an optional time zone offset. When a time zone offset is not specified it will be assumed to be that of the destination point.

Examples:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

The arriveAt parameter cannot be used in conjunction with departAt, minDeviationDistance or minDeviationTime.
avoid

Specifies something that the route calculation should try to avoid when determining the route. Can be specified multiple times in one request, for example, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. In Route Range requests, the value alreadyUsedRoads must not be used.
computeTravelTimeFor

Specifies whether to return additional travel times using different types of traffic information (none, historic, live) as well as the default best-estimate travel time.
departAt

The date and time of departure from the origin point formatted as a dateTime value as defined in RFC 3339, section 5.6, with an optional time zone offset. When a time zone offset is not specified, it will be assumed to be that of the origin point.

  • Default value: now
  • Other value: dateTime

Examples:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

The departAt parameter cannot be used in conjunction with arriveAt.
hilliness

Degree of hilliness for thrilling route. This parameter can only be used in conjunction with routeType=thrilling.
routeType

The type of route requested.
sectionType

Specifies which of the section types is reported in the route response.

For example if sectionType = pedestrian the sections which are suited for pedestrians only are returned. Can be specified multiple times in one request, for example, '&sectionType=carTrain&sectionType=pedestrian&sectionType=motorway'. The default sectionType refers to the travelMode input. By default travelMode is set to car
traffic

Possible values:

  • true - Do consider all available traffic information during routing
  • false - Ignore current traffic data during routing. Note that although the current traffic data is ignored during routing, the effect of historic traffic on effective road speeds is still incorporated.
travelMode

The mode of travel for the requested route. If not defined, default is 'car'. Note that the requested travelMode may not be available for the entire route. Where the requested travelMode is not available for a particular section, the travelMode element of the response for that section will be "other". Note that travel modes bus, motorcycle, taxi and van are BETA functionality. Full restriction data is not available in all areas.
vehicleAxleWeight

Weight per axle of the vehicle in kg. A value of 0 means that weight restrictions per axle are not considered.
vehicleHeight

Height of the vehicle in meters. A value of 0 means that height restrictions are not considered.
vehicleLength

Length of the vehicle in meters. A value of 0 means that length restrictions are not considered.
vehicleLoadType

Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries/regions. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries/regions. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck.
vehicleMaxSpeed

Maximum speed of the vehicle in km/hour. The max speed in the vehicle profile is used to check whether a vehicle is allowed on motorways.

  • A value of 0 means that an appropriate value for the vehicle will be determined and applied during route planning.

  • A non-zero value may be overridden during route planning. For example, the current traffic flow is 60 km/hour. If the vehicle maximum speed is set to 50 km/hour, the routing engine will consider 60 km/hour as this is the current situation. If the maximum speed of the vehicle is provided as 80 km/hour but the current traffic flow is 60 km/hour, then routing engine will again use 60 km/hour.
vehicleWeight

Weight of the vehicle in kilograms.
vehicleWidth

Width of the vehicle in meters. A value of 0 means that width restrictions are not considered.
waitForResults

Boolean to indicate whether to execute the request synchronously. If set to true, user will get a 200 response if the request is finished under 120 seconds. Otherwise, user will get a 202 response right away. Please refer to the API description for more details on 202 response. Supported only for async request.
windingness

Level of turns for thrilling route. This parameter can only be used in conjunction with routeType=thrilling.

Property Details

arriveAt

The date and time of arrival at the destination point formatted as a dateTime value as defined in RFC 3339, section 5.6, with an optional time zone offset. When a time zone offset is not specified it will be assumed to be that of the destination point.

Examples:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

The arriveAt parameter cannot be used in conjunction with departAt, minDeviationDistance or minDeviationTime.

arriveAt?: string | Date

Property Value

string | Date

avoid

Specifies something that the route calculation should try to avoid when determining the route. Can be specified multiple times in one request, for example, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. In Route Range requests, the value alreadyUsedRoads must not be used.

avoid?: ("tollRoads" | "motorways" | "ferries" | "unpavedRoads" | "carpools" | "alreadyUsedRoads" | "borderCrossings")[]

Property Value

("tollRoads" | "motorways" | "ferries" | "unpavedRoads" | "carpools" | "alreadyUsedRoads" | "borderCrossings")[]

computeTravelTimeFor

Specifies whether to return additional travel times using different types of traffic information (none, historic, live) as well as the default best-estimate travel time.

computeTravelTimeFor?: "none" | "all"

Property Value

"none" | "all"

departAt

The date and time of departure from the origin point formatted as a dateTime value as defined in RFC 3339, section 5.6, with an optional time zone offset. When a time zone offset is not specified, it will be assumed to be that of the origin point.

  • Default value: now
  • Other value: dateTime

Examples:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

The departAt parameter cannot be used in conjunction with arriveAt.

departAt?: string | Date

Property Value

string | Date

hilliness

Degree of hilliness for thrilling route. This parameter can only be used in conjunction with routeType=thrilling.

hilliness?: "low" | "normal" | "high"

Property Value

"low" | "normal" | "high"

routeType

The type of route requested.

routeType?: "fastest" | "shortest" | "eco" | "thrilling"

Property Value

"fastest" | "shortest" | "eco" | "thrilling"

sectionType

Specifies which of the section types is reported in the route response.

For example if sectionType = pedestrian the sections which are suited for pedestrians only are returned. Can be specified multiple times in one request, for example, '&sectionType=carTrain&sectionType=pedestrian&sectionType=motorway'. The default sectionType refers to the travelMode input. By default travelMode is set to car

sectionType?: ("carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban")[]

Property Value

("carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban")[]

traffic

Possible values:

  • true - Do consider all available traffic information during routing
  • false - Ignore current traffic data during routing. Note that although the current traffic data is ignored during routing, the effect of historic traffic on effective road speeds is still incorporated.
traffic?: boolean

Property Value

boolean

travelMode

The mode of travel for the requested route. If not defined, default is 'car'. Note that the requested travelMode may not be available for the entire route. Where the requested travelMode is not available for a particular section, the travelMode element of the response for that section will be "other". Note that travel modes bus, motorcycle, taxi and van are BETA functionality. Full restriction data is not available in all areas.

travelMode?: "pedestrian" | "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle"

Property Value

"pedestrian" | "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle"

vehicleAxleWeight

Weight per axle of the vehicle in kg. A value of 0 means that weight restrictions per axle are not considered.

vehicleAxleWeight?: number

Property Value

number

vehicleHeight

Height of the vehicle in meters. A value of 0 means that height restrictions are not considered.

vehicleHeight?: number

Property Value

number

vehicleLength

Length of the vehicle in meters. A value of 0 means that length restrictions are not considered.

vehicleLength?: number

Property Value

number

vehicleLoadType

Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries/regions. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries/regions. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck.

vehicleLoadType?: "USHazmatClass1" | "USHazmatClass2" | "USHazmatClass3" | "USHazmatClass4" | "USHazmatClass5" | "USHazmatClass6" | "USHazmatClass7" | "USHazmatClass8" | "USHazmatClass9" | "otherHazmatExplosive" | "otherHazmatGeneral" | "otherHazmatHarmfulToWater"

Property Value

"USHazmatClass1" | "USHazmatClass2" | "USHazmatClass3" | "USHazmatClass4" | "USHazmatClass5" | "USHazmatClass6" | "USHazmatClass7" | "USHazmatClass8" | "USHazmatClass9" | "otherHazmatExplosive" | "otherHazmatGeneral" | "otherHazmatHarmfulToWater"

vehicleMaxSpeed

Maximum speed of the vehicle in km/hour. The max speed in the vehicle profile is used to check whether a vehicle is allowed on motorways.

  • A value of 0 means that an appropriate value for the vehicle will be determined and applied during route planning.

  • A non-zero value may be overridden during route planning. For example, the current traffic flow is 60 km/hour. If the vehicle maximum speed is set to 50 km/hour, the routing engine will consider 60 km/hour as this is the current situation. If the maximum speed of the vehicle is provided as 80 km/hour but the current traffic flow is 60 km/hour, then routing engine will again use 60 km/hour.

vehicleMaxSpeed?: number

Property Value

number

vehicleWeight

Weight of the vehicle in kilograms.

vehicleWeight?: number

Property Value

number

vehicleWidth

Width of the vehicle in meters. A value of 0 means that width restrictions are not considered.

vehicleWidth?: number

Property Value

number

waitForResults

Boolean to indicate whether to execute the request synchronously. If set to true, user will get a 200 response if the request is finished under 120 seconds. Otherwise, user will get a 202 response right away. Please refer to the API description for more details on 202 response. Supported only for async request.

waitForResults?: boolean

Property Value

boolean

windingness

Level of turns for thrilling route. This parameter can only be used in conjunction with routeType=thrilling.

windingness?: "low" | "normal" | "high"

Property Value

"low" | "normal" | "high"