Compartir a través de

RouteRequestRouteMatrixQueryParamProperties interface

  • Referencia
Paquete:
@azure-rest/maps-route

Propiedades

arriveAt

Fecha y hora de llegada al punto de destino. Debe especificarse como dateTime. Cuando no se especifica un desplazamiento de zona horaria, se supone que es el del punto de destino. El valor de arriveAt debe estar en el futuro. El parámetro arriveAt no se puede usar junto con departAt, minDeviationDistance o minDeviationTime.
avoid

Especifica algo que el cálculo de ruta debe intentar evitar al determinar la ruta. Se puede especificar varias veces en una solicitud, por ejemplo, "&avoid=autopistas&avoid=tollRoads&avoid=ferries". En las solicitudes calculateReachableRange, no se debe usar el valor alreadyUsedRoads.
computeTravelTimeFor

Especifica si se devuelven tiempos de desplazamiento adicionales mediante diferentes tipos de información de tráfico (ninguno, histórico, activo), así como el tiempo de desplazamiento predeterminado de mejor estimación.
departAt

Fecha y hora de salida desde el punto de origen. Las horas de salida aparte de ahora deben especificarse como dateTime. Cuando no se especifica un desplazamiento de zona horaria, se supone que es el del punto de origen. El valor de departAt debe estar en el futuro en el formato de fecha y hora (1996-12-19T16:39:57-08:00).
hilliness

Grado de colina para la emocionante ruta. Este parámetro solo se puede usar junto con routeType=emocionante.
routeType

Tipo de ruta solicitada.
sectionType

Especifica cuál de los tipos de sección se notifica en la respuesta de ruta.

Por ejemplo, si sectionType = peatonal se devuelven las secciones que son adecuadas para los peatones. Se pueden usar varios tipos. El valor predeterminado sectionType hace referencia a la entrada travelMode. De forma predeterminada travelMode está establecido en coche
traffic

Valores posibles:

  • true: considere toda la información de tráfico disponible durante el enrutamiento.
  • false: omite los datos de tráfico actuales durante el enrutamiento. Tenga en cuenta que, aunque los datos de tráfico actuales se omiten durante el enrutamiento, el efecto del tráfico histórico en velocidades de carretera efectivas todavía se incorpora.
travelMode

Modo de desplazamiento para la ruta solicitada. Si no se define, el valor predeterminado es "car". Tenga en cuenta que el travelMode solicitado puede no estar disponible para toda la ruta. Cuando el travelMode solicitado no está disponible para una sección determinada, el elemento travelMode de la respuesta de esa sección será "otro". Tenga en cuenta que los modos de viaje bus, motocicleta, taxi y van son funcionalidad BETA. Los datos de restricción completa no están disponibles en todas las áreas. En las solicitudes calculateReachableRange, no se deben usar los valores de bicicleta y peatonal.
vehicleAxleWeight

Peso por eje del vehículo en kg. Un valor de 0 significa que no se tienen en cuenta las restricciones de peso por eje.
vehicleHeight

Altura del vehículo en metros. Un valor de 0 significa que no se tienen en cuenta las restricciones de altura.
vehicleLength

Longitud del vehículo en metros. Un valor de 0 significa que no se tienen en cuenta las restricciones de longitud.
vehicleLoadType

Tipos de carga que se pueden clasificar como materiales peligrosos y restringidos de algunas carreteras. Los valores de vehicleLoadType disponibles son clases hazmat de EE. UU. de 1 a 9, además de clasificaciones genéricas para su uso en otros países. Los valores que comienzan con USHazmat son para el enrutamiento de EE. UU., mientras que otroshazmat deben usarse para todos los demás países. vehicleLoadType se puede especificar varias veces. Este parámetro solo se considera actualmente para travelMode=truck.
vehicleMaxSpeed

Velocidad máxima del vehículo en km/hora. La velocidad máxima en el perfil del vehículo se utiliza para comprobar si se permite un vehículo en las autopistas.

  • Un valor de 0 significa que se determinará y aplicará un valor adecuado para el vehículo durante el planeamiento de rutas.

  • Un valor distinto de cero se puede invalidar durante el planeamiento de rutas. Por ejemplo, el flujo de tráfico actual es de 60 km/hora. Si la velocidad máxima del vehículo se establece en 50 km/hora, el motor de enrutamiento considerará 60 km/hora, ya que esta es la situación actual. Si la velocidad máxima del vehículo se proporciona como 80 km/hora, pero el flujo de tráfico actual es de 60 km/hora, el motor de enrutamiento volverá a usar 60 km/hora.
vehicleWeight

Peso del vehículo en kilogramos.
vehicleWidth

Ancho del vehículo en metros. Un valor de 0 significa que no se tienen en cuenta las restricciones de ancho.
waitForResults

Boolean para indicar si se va a ejecutar la solicitud de forma sincrónica. Si se establece en true, el usuario obtendrá una respuesta de 200 si la solicitud ha finalizado en menos de 120 segundos. De lo contrario, el usuario obtendrá una respuesta 202 inmediatamente. Consulte la descripción de la API para obtener más información sobre la respuesta 202. solo se admite para la solicitud asincrónica.
windingness

Nivel de giros para una ruta emocionante. Este parámetro solo se puede usar junto con routeType=emocionante.

Detalles de las propiedades

arriveAt

Fecha y hora de llegada al punto de destino. Debe especificarse como dateTime. Cuando no se especifica un desplazamiento de zona horaria, se supone que es el del punto de destino. El valor de arriveAt debe estar en el futuro. El parámetro arriveAt no se puede usar junto con departAt, minDeviationDistance o minDeviationTime.

arriveAt?: string | Date

Valor de propiedad

string | Date

avoid

Especifica algo que el cálculo de ruta debe intentar evitar al determinar la ruta. Se puede especificar varias veces en una solicitud, por ejemplo, "&avoid=autopistas&avoid=tollRoads&avoid=ferries". En las solicitudes calculateReachableRange, no se debe usar el valor alreadyUsedRoads.

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

Valor de propiedad

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

computeTravelTimeFor

Especifica si se devuelven tiempos de desplazamiento adicionales mediante diferentes tipos de información de tráfico (ninguno, histórico, activo), así como el tiempo de desplazamiento predeterminado de mejor estimación.

computeTravelTimeFor?: "none" | "all"

Valor de propiedad

"none" | "all"

departAt

Fecha y hora de salida desde el punto de origen. Las horas de salida aparte de ahora deben especificarse como dateTime. Cuando no se especifica un desplazamiento de zona horaria, se supone que es el del punto de origen. El valor de departAt debe estar en el futuro en el formato de fecha y hora (1996-12-19T16:39:57-08:00).

departAt?: string | Date

Valor de propiedad

string | Date

hilliness

Grado de colina para la emocionante ruta. Este parámetro solo se puede usar junto con routeType=emocionante.

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

Valor de propiedad

"low" | "normal" | "high"

routeType

Tipo de ruta solicitada.

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

Valor de propiedad

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

sectionType

Especifica cuál de los tipos de sección se notifica en la respuesta de ruta.

Por ejemplo, si sectionType = peatonal se devuelven las secciones que son adecuadas para los peatones. Se pueden usar varios tipos. El valor predeterminado sectionType hace referencia a la entrada travelMode. De forma predeterminada travelMode está establecido en coche

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

Valor de propiedad

"carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban"

traffic

Valores posibles:

  • true: considere toda la información de tráfico disponible durante el enrutamiento.
  • false: omite los datos de tráfico actuales durante el enrutamiento. Tenga en cuenta que, aunque los datos de tráfico actuales se omiten durante el enrutamiento, el efecto del tráfico histórico en velocidades de carretera efectivas todavía se incorpora.
traffic?: boolean

Valor de propiedad

boolean

travelMode

Modo de desplazamiento para la ruta solicitada. Si no se define, el valor predeterminado es "car". Tenga en cuenta que el travelMode solicitado puede no estar disponible para toda la ruta. Cuando el travelMode solicitado no está disponible para una sección determinada, el elemento travelMode de la respuesta de esa sección será "otro". Tenga en cuenta que los modos de viaje bus, motocicleta, taxi y van son funcionalidad BETA. Los datos de restricción completa no están disponibles en todas las áreas. En las solicitudes calculateReachableRange, no se deben usar los valores de bicicleta y peatonal.

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

Valor de propiedad

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

vehicleAxleWeight

Peso por eje del vehículo en kg. Un valor de 0 significa que no se tienen en cuenta las restricciones de peso por eje.

vehicleAxleWeight?: number

Valor de propiedad

number

vehicleHeight

Altura del vehículo en metros. Un valor de 0 significa que no se tienen en cuenta las restricciones de altura.

vehicleHeight?: number

Valor de propiedad

number

vehicleLength

Longitud del vehículo en metros. Un valor de 0 significa que no se tienen en cuenta las restricciones de longitud.

vehicleLength?: number

Valor de propiedad

number

vehicleLoadType

Tipos de carga que se pueden clasificar como materiales peligrosos y restringidos de algunas carreteras. Los valores de vehicleLoadType disponibles son clases hazmat de EE. UU. de 1 a 9, además de clasificaciones genéricas para su uso en otros países. Los valores que comienzan con USHazmat son para el enrutamiento de EE. UU., mientras que otroshazmat deben usarse para todos los demás países. vehicleLoadType se puede especificar varias veces. Este parámetro solo se considera actualmente para travelMode=truck.

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

Valor de propiedad

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

vehicleMaxSpeed

Velocidad máxima del vehículo en km/hora. La velocidad máxima en el perfil del vehículo se utiliza para comprobar si se permite un vehículo en las autopistas.

  • Un valor de 0 significa que se determinará y aplicará un valor adecuado para el vehículo durante el planeamiento de rutas.

  • Un valor distinto de cero se puede invalidar durante el planeamiento de rutas. Por ejemplo, el flujo de tráfico actual es de 60 km/hora. Si la velocidad máxima del vehículo se establece en 50 km/hora, el motor de enrutamiento considerará 60 km/hora, ya que esta es la situación actual. Si la velocidad máxima del vehículo se proporciona como 80 km/hora, pero el flujo de tráfico actual es de 60 km/hora, el motor de enrutamiento volverá a usar 60 km/hora.

vehicleMaxSpeed?: number

Valor de propiedad

number

vehicleWeight

Peso del vehículo en kilogramos.

vehicleWeight?: number

Valor de propiedad

number

vehicleWidth

Ancho del vehículo en metros. Un valor de 0 significa que no se tienen en cuenta las restricciones de ancho.

vehicleWidth?: number

Valor de propiedad

number

waitForResults

Boolean para indicar si se va a ejecutar la solicitud de forma sincrónica. Si se establece en true, el usuario obtendrá una respuesta de 200 si la solicitud ha finalizado en menos de 120 segundos. De lo contrario, el usuario obtendrá una respuesta 202 inmediatamente. Consulte la descripción de la API para obtener más información sobre la respuesta 202. solo se admite para la solicitud asincrónica.

waitForResults?: boolean

Valor de propiedad

boolean

windingness

Nivel de giros para una ruta emocionante. Este parámetro solo se puede usar junto con routeType=emocionante.

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

Valor de propiedad

"low" | "normal" | "high"