RouteDirectionsRequestBody interface

Package:

azure-maps-rest

Post body parameters for Route directions.

Properties

allowVignette	This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries in which toll roads with vignettes are allowed, e.g. "AUS,CHE". Specifying allowVignette with some countries X is equivalent to specifying avoidVignette with all countries but X. Specifying allowVignette with an empty list is the same as avoiding all toll roads with vignettes. Note: It is an error to specify both avoidVignette and allowVignette.
avoidAreas	A GeoJSON MultiPolygon representing list of areas to avoid. Only rectangle polygons are supported. The maximum size of a rectangle is about 160x160 km. It cannot cross the 180th meridian. It must be between -80 and +80 degrees of latitude.
avoidVignette	This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries in which all toll roads with vignettes are to be avoided, e.g. "AUS,CHE". Toll roads with vignettes in countries not in the list are unaffected. Note: It is an error to specify both avoidVignette and allowVignette.
supportingPoints	A GeoJSON Geometry collection representing sequence of coordinates used as input for route reconstruction

Property Details

allowVignette

This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries in which toll roads with vignettes are allowed, e.g. "AUS,CHE". Specifying allowVignette with some countries X is equivalent to specifying avoidVignette with all countries but X. Specifying allowVignette with an empty list is the same as avoiding all toll roads with vignettes. Note: It is an error to specify both avoidVignette and allowVignette.

allowVignette?: string[]

Property Value

string[]

avoidAreas

A GeoJSON MultiPolygon representing list of areas to avoid. Only rectangle polygons are supported. The maximum size of a rectangle is about 160x160 km. It cannot cross the 180th meridian. It must be between -80 and +80 degrees of latitude.

avoidAreas?: MultiPolygon

Property Value

MultiPolygon

avoidVignette

This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries in which all toll roads with vignettes are to be avoided, e.g. "AUS,CHE". Toll roads with vignettes in countries not in the list are unaffected. Note: It is an error to specify both avoidVignette and allowVignette.

avoidVignette?: string[]

Property Value

string[]

supportingPoints

A GeoJSON Geometry collection representing sequence of coordinates used as input for route reconstruction

supportingPoints?: RouteDirectionsRequestBodySupportingPoints

Property Value

RouteDirectionsRequestBodySupportingPoints