Share via

RouteDirectionParameters interface

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

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. Maximum number of avoided areas is 10. 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 and for calculating zero or more alternative routes to this reference route.

  • The provided sequence of supporting points is used as input for route reconstruction.
  • The alternative routes are calculated between the origin and destination points specified in the base path parameter locations.
  • If both minDeviationDistance and minDeviationTime are set to zero, then these origin and destination points are expected to be at (or very near) the beginning and end of the reference route, respectively.
  • Intermediate locations (waypoints) are not supported when using <supportingPoints>.
  • The reference route may contain traffic incidents of type ROAD_CLOSURE, which are ignored for the calculation of the reference route's travel time and traffic delay.

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. Maximum number of avoided areas is 10. It cannot cross the 180th meridian. It must be between -80 and +80 degrees of latitude.

avoidAreas?: GeoJsonMultiPolygon

Property Value

GeoJsonMultiPolygon

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 and for calculating zero or more alternative routes to this reference route.

  • The provided sequence of supporting points is used as input for route reconstruction.
  • The alternative routes are calculated between the origin and destination points specified in the base path parameter locations.
  • If both minDeviationDistance and minDeviationTime are set to zero, then these origin and destination points are expected to be at (or very near) the beginning and end of the reference route, respectively.
  • Intermediate locations (waypoints) are not supported when using <supportingPoints>.
  • The reference route may contain traffic incidents of type ROAD_CLOSURE, which are ignored for the calculation of the reference route's travel time and traffic delay.
supportingPoints?: Record<string, unknown>

Property Value

Record<string, unknown>