Route - Get Route Directions

Referencia

Service:: Maps

API Version:: 1.0

Use para calcular una ruta entre un origen y un destino especificados, pasando por los puntos de referencia especificados.

La Get Route Directions API es una solicitud HTTP GET que devuelve una ruta entre un origen y un destino, pasando por puntos de referencia si se especifica. La ruta tiene en cuenta factores como el tráfico actual y las velocidades típicas de carretera en el día solicitado de la semana y la hora del día.

La información devuelta incluye la distancia, el tiempo de desplazamiento estimado y una representación de la geometría de ruta. También hay disponible información de enrutamiento adicional, como el orden optimizado del punto de referencia o las instrucciones de turno por turno, en función de las opciones seleccionadas.

El servicio de enrutamiento proporciona un conjunto de parámetros para una descripción detallada de un modelo de consumo específico del vehículo. Para obtener más información, vea Modelo de consumo.

GET https://atlas.microsoft.com/route/directions/{format}?api-version=1.0&query={query}

With optional parameters:

GET https://atlas.microsoft.com/route/directions/{format}?api-version=1.0&query={query}&maxAlternatives={maxAlternatives}&alternativeType={alternativeType}&minDeviationDistance={minDeviationDistance}&arriveAt={arriveAt}&departAt={departAt}&minDeviationTime={minDeviationTime}&instructionsType={instructionsType}&language={language}&computeBestOrder={computeBestOrder}&routeRepresentation={routeRepresentation}&computeTravelTimeFor={computeTravelTimeFor}&vehicleHeading={vehicleHeading}&report=effectiveSettings&sectionType={sectionType}&vehicleAxleWeight={vehicleAxleWeight}&vehicleWidth={vehicleWidth}&vehicleHeight={vehicleHeight}&vehicleLength={vehicleLength}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&vehicleCommercial={vehicleCommercial}&windingness={windingness}&hilliness={hilliness}&travelMode={travelMode}&avoid={avoid}&traffic={traffic}&routeType={routeType}&vehicleLoadType={vehicleLoadType}&vehicleEngineType={vehicleEngineType}&constantSpeedConsumptionInLitersPerHundredkm={constantSpeedConsumptionInLitersPerHundredkm}&currentFuelInLiters={currentFuelInLiters}&auxiliaryPowerInLitersPerHour={auxiliaryPowerInLitersPerHour}&fuelEnergyDensityInMJoulesPerLiter={fuelEnergyDensityInMJoulesPerLiter}&accelerationEfficiency={accelerationEfficiency}&decelerationEfficiency={decelerationEfficiency}&uphillEfficiency={uphillEfficiency}&downhillEfficiency={downhillEfficiency}&constantSpeedConsumptionInkWhPerHundredkm={constantSpeedConsumptionInkWhPerHundredkm}&currentChargeInkWh={currentChargeInkWh}&maxChargeInkWh={maxChargeInkWh}&auxiliaryPowerInkW={auxiliaryPowerInkW}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
format	path	True	ResponseFormat	Formato deseado de la respuesta. El valor puede ser json o xml.
api-version	query	True	string	Número de versión de la API de Azure Maps.
query	query	True	string	Coordenadas a través de las que se calcula la ruta, delimitada por dos puntos. Se requiere un mínimo de dos coordenadas. La primera es el origen y la última es el destino de la ruta. Las coordenadas opcionales entre actúan como WayPoints en la ruta. Puede pasar hasta 150 WayPoints.
accelerationEfficiency	query		number double	Especifica la eficiencia de la conversión de energía química almacenada en combustible a energía cinética cuando el vehículo se acelera (es decir, CinéticaEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed se obtiene convirtiendo el combustible consumido en energía química utilizando fuelEnergyDensityInMJoulesPerLiter. Debe emparejarse con deceleraciónEfficiency. El intervalo de valores permitidos es de 0,0 a 1/deceleraciónEfficiency. Valores sensibles: para el modelo de combustión : 0,33, para el modelo eléctrico : 0,66
alternativeType	query		AlternativeRouteType	Controla la óptimaidad, con respecto a los criterios de planificación especificados, de las alternativas calculadas en comparación con la ruta de referencia.
arriveAt	query		string date-time	La fecha y hora de llegada al punto de destino con formato de `dateTime` valor tal y como se define en RFC 3339, sección 5.6, con un desplazamiento de zona horaria opcional. Cuando no se especifica un desplazamiento de zona horaria, se supone que es el del punto de destino. Ejemplos: 2023-12-19T16:39:57 2023-12-20T00:39:57+00:00 El `arriveAt` parámetro no se puede usar junto con `departAt`, `minDeviationDistance` o `minDeviationTime`.
auxiliaryPowerInkW	query		number double	Especifica la cantidad de energía consumida para mantener sistemas auxiliares, en kilowatts (kW). Se puede utilizar para especificar el consumo debido a dispositivos y sistemas como sistemas DE CA, radio, calefacción, etc. Valores sensibles: 1,7
auxiliaryPowerInLitersPerHour	query		number double	Especifica la cantidad de combustible consumido para mantener sistemas auxiliares del vehículo, en litros por hora. Se puede utilizar para especificar el consumo debido a dispositivos y sistemas como sistemas DE CA, radio, calefacción, etc. Valores sensibles: 0,2
avoid	query		RouteAvoidType[]	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 de intervalo de rutas, no se debe usar el valor alreadyUsedRoads.
computeBestOrder	query		boolean	Vuelva a ordenar los puntos de ruta mediante un algoritmo heurístico rápido para reducir la longitud de la ruta. Produce mejores resultados cuando se usa junto con routeType shortest. Observe que el origen y el destino se excluyen de los índices de punto de referencia optimizados. Para incluir el origen y el destino en la respuesta, aumente todos los índices en 1 para tener en cuenta el origen y, a continuación, agregue el destino como índice final. Los valores posibles son true o false. True calcula un mejor orden si es posible, pero no se puede usar junto con el valor maxAlternatives mayor que 0 o junto con los puntos de referencia de círculo. False usará las ubicaciones en el orden especificado y no podrá usarse junto con routeRepresentation none.
computeTravelTimeFor	query		ComputeTravelTime	Especifica si se deben devolver tiempos de desplazamiento adicionales mediante diferentes tipos de información de tráfico (ninguno, histórico, activo), así como el tiempo de viaje predeterminado de mejor estimación.
constantSpeedConsumptionInkWhPerHundredkm	query		string	Especifica el componente dependiente de la velocidad del consumo. Se proporciona como una lista desordenada de pares de velocidad/velocidad de consumo. La lista define puntos en una curva de consumo. Las tasas de consumo de velocidades que no están en la lista se encuentran de la siguiente manera: por interpolación lineal, si la velocidad dada se encuentra entre dos velocidades de la lista por extrapolación lineal de lo contrario, suponiendo una constante (ΔConsumption/ΔSpeed) determinada por los dos puntos más cercanos de la lista La lista debe contener entre 1 y 25 puntos (inclusive), y puede que no contenga puntos duplicados para la misma velocidad. Si solo contiene un único punto, la tasa de consumo de ese punto se usa sin procesamiento adicional. El consumo especificado para la mayor velocidad debe ser mayor o igual que el de la penúltima velocidad más grande. Esto garantiza que la extrapolación no conduce a tasas de consumo negativas. De forma similar, los valores de consumo especificados para las dos velocidades más pequeñas de la lista no pueden dar lugar a una tasa de consumo negativa para cualquier velocidad menor. El intervalo válido para los valores de consumo (expresados en kWh/100km) está comprendido entre 0,01 y 100000,0. Valores sensibles: 50,8.2:130,21.3 Este parámetro es necesario para el modelo de consumo eléctrico.
constantSpeedConsumptionInLitersPerHundredkm	query		string	Especifica el componente dependiente de la velocidad del consumo. Se proporciona como una lista desordenada de velocidad delimitada por dos puntos & pares de tasa de consumo. La lista define puntos en una curva de consumo. Las tasas de consumo de velocidades que no están en la lista se encuentran de la siguiente manera: por interpolación lineal, si la velocidad dada se encuentra entre dos velocidades de la lista por extrapolación lineal de lo contrario, suponiendo una constante (ΔConsumption/ΔSpeed) determinada por los dos puntos más cercanos de la lista La lista debe contener entre 1 y 25 puntos (inclusive), y puede que no contenga puntos duplicados para la misma velocidad. Si solo contiene un único punto, la tasa de consumo de ese punto se usa sin procesamiento adicional. El consumo especificado para la mayor velocidad debe ser mayor o igual que el de la penúltima velocidad más grande. Esto garantiza que la extrapolación no conduce a tasas de consumo negativas. De forma similar, los valores de consumo especificados para las dos velocidades más pequeñas de la lista no pueden dar lugar a una tasa de consumo negativa para cualquier velocidad menor. El intervalo válido para los valores de consumo (expresados en l/100km) está comprendido entre 0,01 y 100000,0. Valores sensibles: 50,6.3:130,11.5 Nota : Este parámetro es necesario para el modelo de consumo de combustión.
currentChargeInkWh	query		number double	Especifica la fuente de energía eléctrica actual en horas de kilowatt (kWh). Este parámetro coexiste con el parámetro maxChargeInkWh . El intervalo de valores permitidos es de 0,0 a maxChargeInkWh. Valores sensibles: 43
currentFuelInLiters	query		number double	Especifica el suministro actual de combustible en litros. Valores sensibles: 55
decelerationEfficiency	query		number double	Especifica la eficiencia de la conversión de energía cinética en combustible ahorrado (no consumido) cuando el vehículo se decelera (es decir, ChemicalEnergySaved/CinéticaEnergyLost). ChemicalEnergySaved se obtiene convirtiendo combustible guardado (no consumido) en energía utilizando fuelEnergyDensityInMJoulesPerLiter. Debe emparejarse con accelerationEfficiency. El intervalo de valores permitidos es de 0,0 a 1/accelerationEfficiency. Valores sensibles : para el modelo de combustión : 0,83, para el modelo eléctrico : 0,91
departAt	query		string date-time	Fecha y hora de salida del punto de origen con formato de `dateTime` valor definido en RFC 3339, sección 5.6, con un desplazamiento de zona horaria opcional. Cuando no se especifica un desplazamiento de zona horaria, se supone que es el del punto de origen. Valor predeterminado: ahora Otro valor: `dateTime` Ejemplos: 2023-12-19T16:39:57 2023-12-20T00:39:57+00:00 El `departAt` parámetro no se puede usar junto con `arriveAt`.
downhillEfficiency	query		number double	Especifica la eficiencia de la conversión de energía potencial a combustible ahorrado (no consumido) cuando el vehículo pierde la elevación (es decir, ChemicalEnergySaved/PotentialEnergyLost). ChemicalEnergySaved se obtiene convirtiendo combustible guardado (no consumido) en energía utilizando fuelEnergyDensityInMJoulesPerLiter. Debe emparejarse con uphillEfficiency. El intervalo de valores permitidos es de 0,0 a 1/uphillEfficiency. Valores sensibles : para el modelo de combustión : 0,51, para el modelo eléctrico : 0,73
fuelEnergyDensityInMJoulesPerLiter	query		number double	Especifica la cantidad de energía química almacenada en un litro de combustible en megajoules (MJ). Se utiliza junto con los parámetros *Efficiency para conversiones entre energía guardada o consumida y combustible. Por ejemplo, la densidad energética es de 34,2 MJ/l para gasolina y 35,8 MJ/l para combustible diesel. Este parámetro es necesario si se establece algún parámetro *Efficiency . Valores sensibles: 34.2
hilliness	query		InclineLevel	Grado de colina para la emocionante ruta. Este parámetro solo se puede usar junto con `routeType`=thrilling.
instructionsType	query		RouteInstructionsType	Si se especifica, se devolverán instrucciones de instrucciones. Tenga en cuenta que el parámetro instructionsType no se puede usar junto con routeRepresentation=none
language	query		string	El parámetro language determina el idioma de los mensajes de guía. Los nombres adecuados (los nombres de calles, plazas, etc.) se devuelven en el idioma especificado, o si no está disponible, se devuelven en un idioma disponible que está cerca de él. Los valores permitidos son (un subconjunto de) las etiquetas de lenguaje IETF. Los idiomas admitidos actualmente se muestran en la sección Idiomas admitidos. Valor predeterminado: en-GB
maxAlternatives	query		integer	Número de rutas alternativas deseadas que se van a calcular. Valor predeterminado: 0, mínimo: 0 y máximo: 5
maxChargeInkWh	query		number double	Especifica el suministro máximo de energía eléctrica en kilowatt horas (kWh) que se pueden almacenar en la batería del vehículo. Este parámetro coexiste con el parámetro currentChargeInkWh . El valor mínimo debe ser mayor o igual que currentChargeInkWh. Valores sensibles: 85
minDeviationDistance	query		integer	Todas las rutas alternativas devueltas seguirán la ruta de referencia (consulte la sección SOLICITUDES POST) desde el punto de origen de la solicitud calculateRoute para al menos este número de metros. Solo se puede usar al reconstruir una ruta. El parámetro minDeviationDistance no se puede usar junto con arriveAt
minDeviationTime	query		integer	Todas las rutas alternativas devueltas seguirán la ruta de referencia (consulte la sección SOLICITUDES POST) desde el punto de origen de la solicitud calculateRoute durante al menos este número de segundos. Solo se puede usar al reconstruir una ruta. El parámetro minDeviationTime no se puede usar junto con arriveAt. El valor predeterminado es 0. Establecer )minDeviationTime_ en un valor mayor que cero tiene las siguientes consecuencias: El punto de origen de la solicitud calculateRoute debe estar en (o muy cerca) de la ruta de referencia de entrada. Si no es así, se devuelve un error. Sin embargo, el punto de origen no necesita estar al principio de la ruta de referencia de entrada (se puede considerar como la posición actual del vehículo en la ruta de referencia). La ruta de referencia, devuelta como la primera ruta de la respuesta calculateRoute , se iniciará en el punto de origen especificado en la solicitud calculateRoute . La parte inicial de la ruta de referencia de entrada hasta que el punto de origen se excluirá de la respuesta. Los valores de minDeviationDistance y minDeviationTime determinan hasta qué punto se garantiza que las rutas alternativas sigan la ruta de referencia desde el punto de origen en adelante. La ruta debe usar departAt. El vehículoHeading se omite.
report	query		Report	Especifica qué datos se deben notificar con fines de diagnóstico. El único valor posible es effectiveSettings. Notifica los parámetros o datos efectivos que se usan al llamar a la API. En el caso de los parámetros predeterminados, el valor predeterminado se reflejará donde el autor de la llamada no especificó el parámetro.
routeRepresentation	query		RouteRepresentationForBestOrder	Especifica la representación del conjunto de rutas proporcionadas como respuesta. Este valor de parámetro solo se puede usar junto con computeBestOrder=true.
routeType	query		RouteType	Tipo de ruta solicitada.
sectionType	query		SectionType	Especifica cuál de los tipos de sección se notifica en la respuesta de ruta. Por ejemplo, si sectionType = peatonal las secciones que son adecuadas para los peatonales solo se devuelven. Se pueden usar varios tipos. El sectionType predeterminado hace referencia a la entrada travelMode. De forma predeterminada travelMode está establecido en coche.
traffic	query		boolean	Valores posibles: true: considere toda la información de tráfico disponible durante el enrutamiento. false: omita 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 sigue incorporando.
travelMode	query		TravelMode	Modo de viaje para la ruta solicitada. Si no se define, el valor predeterminado es "car". Tenga en cuenta que es posible que el travelMode solicitado no esté 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 camioneta son funcionalidad BETA. Los datos de restricción completa no están disponibles en todas las áreas.
uphillEfficiency	query		number double	Especifica la eficiencia de la conversión de energía química almacenada en combustible a energía potencial cuando el vehículo obtiene elevación (es decir, PotentialEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed se obtiene convirtiendo el combustible consumido en energía química utilizando fuelEnergyDensityInMJoulesPerLiter. Debe emparejarse con downhillEfficiency. El intervalo de valores permitidos es de 0,0 a 1/downhillEfficiency. Valores sensibles: para el modelo de combustión : 0,27, para el modelo eléctrico : 0,74
vehicleAxleWeight	query		integer	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.
vehicleCommercial	query		boolean	Si el vehículo se utiliza con fines comerciales. Es posible que los vehículos comerciales no puedan conducir en algunas carreteras.
vehicleEngineType	query		VehicleEngineType	Tipo de motor del vehículo. Cuando se especifica un modelo de consumo detallado, debe ser coherente con el valor de vehicleEngineType.
vehicleHeading	query		integer	El rumbo direccional del vehículo en grados a partir del verdadero Norte y continuando en dirección en sentido de las agujas del reloj. El norte es de 0 grados, este es de 90 grados, sur es de 180 grados, oeste es de 270 grados. Valores posibles entre 0 y 359
vehicleHeight	query		number double	Altura del vehículo en metros. Un valor de 0 significa que no se tienen en cuenta las restricciones de altura.
vehicleLength	query		number double	Longitud del vehículo en metros. Un valor de 0 significa que no se tienen en cuenta las restricciones de longitud.
vehicleLoadType	query		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 o regiones. 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 o regiones. vehicleLoadType se puede especificar varias veces. Este parámetro solo se considera actualmente para travelMode=truck.
vehicleMaxSpeed	query		integer	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 la planificación 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 tendrá en cuenta 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 usará de nuevo 60 km/hora.
vehicleWeight	query		integer	Peso del vehículo en kilogramos. Es obligatorio si se establece cualquiera de los parámetros Efficiency. Debe ser estrictamente positivo cuando se usa en el contexto del modelo de consumo. Se tienen en cuenta las restricciones de peso. Si no se especifica ningún modelo de consumo* detallado y el valor de vehicleWeight es distinto de cero, se tienen en cuenta las restricciones de peso. En todos los demás casos, este parámetro se omite. Valores razonables : para el modelo de combustión : 1600, para el modelo eléctrico : 1900
vehicleWidth	query		number double	Ancho del vehículo en metros. Un valor de 0 significa que no se tienen en cuenta las restricciones de ancho.
windingness	query		WindingnessLevel	Nivel de turnos para una ruta emocionante. Este parámetro solo se puede usar junto con `routeType`=thrilling.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
x-ms-client-id		string	Especifica qué cuenta está pensada para su uso junto con el modelo de seguridad de Microsoft Entra ID. Representa un identificador único para la cuenta de Azure Maps y se puede recuperar de la API de cuenta del plano de administración de Azure Maps. Para usar Microsoft Entra ID seguridad en Azure Maps consulte los siguientes artículos para obtener instrucciones.

Respuestas

Nombre	Tipo	Description
200 OK	RouteDirections	Aceptar
Other Status Codes	ErrorResponse	Se ha producido un error inesperado.

Seguridad

AADToken

Estos son los flujos de OAuth 2.0 de Microsoft Entra. Cuando se empareja con el control de acceso basado en rol de Azure, se puede usar para controlar el acceso a Azure Maps API REST. Los controles de acceso basados en roles de Azure se usan para designar el acceso a una o varias Azure Maps cuenta de recursos o subrecursos. A cualquier usuario, grupo o entidad de servicio se le puede conceder acceso a través de un rol integrado o un rol personalizado compuesto por uno o varios permisos para Azure Maps API REST.

Para implementar escenarios, se recomienda ver los conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para el modelado de aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.

Notas

Esta definición de seguridad requiere el uso del x-ms-client-id encabezado para indicar a qué recurso Azure Maps la aplicación solicita acceso. Esto se puede adquirir desde la API de administración de Maps.

Authorization URL es específico de la instancia de nube pública de Azure. Las nubes soberanas tienen direcciones URL de autorización únicas y configuraciones de Microsoft Entra ID. * El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST. * El uso del SDK web de Azure Maps permite la configuración basada en la configuración de una aplicación para varios casos de uso.

Para obtener más información sobre Plataforma de identidad de Microsoft, consulte Plataforma de identidad de Microsoft información general.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Se trata de una clave compartida que se aprovisiona al Create una cuenta de Azure Maps en el Azure Portal o mediante PowerShell, la CLI, los SDK de Azure o la API REST.

Con esta clave, cualquier aplicación puede acceder a todas las API REST. En otras palabras, esta clave se puede usar como clave maestra en la cuenta en la que se emiten.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es usar el enfoque de aplicaciones cliente confidenciales para acceder a Azure Maps API REST para que la clave se pueda almacenar de forma segura.

Type: apiKey
In: query

SAS Token

Se trata de un token de firma de acceso compartido que se crea a partir de la operación List SAS en el recurso de Azure Maps a través del plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.

Con este token, cualquier aplicación está autorizada para acceder a los controles de acceso basado en roles de Azure y al control específico de la expiración, la tasa y las regiones de uso para el token determinado. Es decir, el token de SAS se puede usar para permitir que las aplicaciones controlen el acceso de forma más segura que la clave compartida.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es configurar una lista específica de orígenes permitidos en el recurso de la cuenta de mapa para limitar la representación de abusos y renovar periódicamente el token de SAS.

Type: apiKey
In: header

Ejemplos

Successfully retrieve a route between an origin and a destination

Sample Request

HTTP

GET https://atlas.microsoft.com/route/directions/json?api-version=1.0&query=52.50931,13.42936:52.50274,13.43872&report=effectiveSettings

Sample Response

Status code:: 200

{
  "formatVersion": "0.0.12",
  "routes": [
    {
      "summary": {
        "lengthInMeters": 1147,
        "travelTimeInSeconds": 162,
        "trafficDelayInSeconds": 0,
        "departureTime": "2017-09-07T16:56:58+00:00",
        "arrivalTime": "2017-09-07T16:59:40+00:00"
      },
      "legs": [
        {
          "summary": {
            "lengthInMeters": 1147,
            "travelTimeInSeconds": 162,
            "trafficDelayInSeconds": 0,
            "departureTime": "2017-09-07T16:56:58+00:00",
            "arrivalTime": "2017-09-07T16:59:40+00:00"
          },
          "points": [
            {
              "latitude": 52.50931,
              "longitude": 13.42937
            },
            {
              "latitude": 52.50904,
              "longitude": 13.42912
            },
            {
              "latitude": 52.50894,
              "longitude": 13.42904
            },
            {
              "latitude": 52.50867,
              "longitude": 13.42879
            },
            {
              "latitude": 52.5084,
              "longitude": 13.42857
            },
            {
              "latitude": 52.50791,
              "longitude": 13.42824
            },
            {
              "latitude": 52.50757,
              "longitude": 13.42772
            },
            {
              "latitude": 52.50735,
              "longitude": 13.42823
            },
            {
              "latitude": 52.5073,
              "longitude": 13.42836
            },
            {
              "latitude": 52.50573,
              "longitude": 13.43194
            },
            {
              "latitude": 52.50512,
              "longitude": 13.43336
            },
            {
              "latitude": 52.50464,
              "longitude": 13.43451
            },
            {
              "latitude": 52.5045,
              "longitude": 13.43481
            },
            {
              "latitude": 52.50443,
              "longitude": 13.43498
            },
            {
              "latitude": 52.50343,
              "longitude": 13.43737
            },
            {
              "latitude": 52.50274,
              "longitude": 13.43872
            }
          ]
        }
      ],
      "sections": [
        {
          "startPointIndex": 0,
          "endPointIndex": 15,
          "sectionType": "TRAVEL_MODE",
          "travelMode": "car"
        }
      ]
    }
  ]
}

Definiciones

Nombre	Description
AlternativeRouteType	Controla la óptimaidad, con respecto a los criterios de planificación especificados, de las alternativas calculadas en comparación con la ruta de referencia.
ComputeTravelTime	Especifica si se devuelven tiempos de viaje adicionales mediante diferentes tipos de información de tráfico (ninguno, histórico, activo), así como el tiempo de viaje predeterminado de mejor estimación.
DelayMagnitude	Magnitud del retraso causado por el incidente. Estos valores corresponden a los valores del campo de respuesta ty de get Traffic Incident Detail API.
DrivingSide	Indica la conducción a la izquierda frente a la derecha en el punto de la maniobra.
EffectiveSetting	Parámetro o datos efectivos que se usan al llamar a esta API de ruta.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
GuidanceInstructionType	Tipo de instrucción, por ejemplo, giro o cambio de forma de carretera.
GuidanceManeuver	Código que identifica la maniobra.
InclineLevel	Grado de colina para la emocionante ruta. Este parámetro solo se puede usar junto con `routeType`=thrilling.
JunctionType	Tipo de unión donde tiene lugar la maniobra. En el caso de los redondeos más grandes, se generan dos instrucciones independientes para entrar y salir de la rotonda.
LatLongPair	Una ubicación representada como latitud y longitud.
Report	Especifica qué datos se deben notificar con fines de diagnóstico. El único valor posible es effectiveSettings. Informa de los parámetros o datos efectivos que se usan al llamar a la API. En el caso de los parámetros predeterminados, el valor predeterminado se reflejará donde el autor de la llamada no especificó el parámetro.
ResponseFormat	Formato deseado de la respuesta. El valor puede ser json o xml.
ResponseSectionType	Tipos de sección de la respuesta de ruta notificada
ResponseTravelMode	Modo de desplazamiento para la ruta calculada. El valor se establecerá `other` en si el modo de transporte solicitado no es posible en esta sección.
Route
RouteAvoidType	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 de intervalo de rutas, no se debe usar el valor alreadyUsedRoads.
RouteDirections	Este objeto se devuelve desde una llamada a Route Directions correcta.
RouteGuidance	Contiene elementos relacionados con la guía. Este campo solo está presente cuando se solicitó la guía y está disponible.
RouteInstruction	Conjunto de atributos que describen una maniobra, por ejemplo, "Girar a la derecha", "Mantener la izquierda", "Tomar el ferry", "Tomar la autopista", "Llegar".
RouteInstructionGroup	Agrupa una secuencia de elementos de instrucción que están relacionados entre sí. El intervalo de secuencia está restringido con firstInstructionIndex y lastInstructionIndex. Cuando se solicitan mensajes de texto legibles para instrucciones (instructionType=text o etiquetados), el elemento instructionGroup tiene un mensaje de resumen devuelto cuando está disponible.
RouteInstructionsType	Si se especifica, se devolverán instrucciones de instrucciones. Tenga en cuenta que el parámetro instructionsType no se puede usar junto con routeRepresentation=none
RouteLeg	Descripción de una parte de una ruta, formada por una lista de puntos. Cada punto de referencia adicional proporcionado en la solicitud dará como resultado una etapa adicional en la ruta devuelta.
RouteLegSummary	Objeto de resumen para la sección de ruta.
RouteOptimizedWaypoint	Objeto de punto de forma optimizado.
RouteReport	Informa de la configuración efectiva usada en la llamada actual.
RouteRepresentationForBestOrder	Especifica la representación del conjunto de rutas proporcionadas como respuesta. Este valor de parámetro solo se puede usar junto con computeBestOrder=true.
RouteSection	Las secciones de ruta contienen información adicional sobre partes de una ruta. Cada sección contiene al menos los elementos `startPointIndex`, `endPointIndex`y `sectionType`.
RouteSectionTec	Detalles del evento de tráfico, usando definiciones en el estándar TPEG2-TEC . Puede contener effectCode y provoca elementos.
RouteSectionTecCause	Causa del evento de tráfico. Puede contener elementos mainCauseCode y subCauseCode. Se puede usar para definir la iconografía y las descripciones.
RouteSummary	Summary (objeto)
RouteType	Tipo de ruta solicitada.
SectionType	Especifica cuáles de los tipos de sección se notifican en la respuesta de ruta. Por ejemplo, si sectionType = peatonal las secciones que son adecuadas para los peatones solo se devuelven. Se pueden usar varios tipos. El valor predeterminado sectionType hace referencia a la entrada travelMode. De forma predeterminada, travelMode está establecido en coche.
SimpleCategory	Tipo del incidente. Actualmente puede ser JAM, ROAD_WORK, ROAD_CLOSURE u OTRO. Consulte "tec" para obtener información detallada.
TravelMode	Modo de viaje para la ruta solicitada. Si no se define, el valor predeterminado es "car". Tenga en cuenta que es posible que el travelMode solicitado no esté 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 camioneta son funcionalidad BETA. Los datos de restricción completa no están disponibles en todas las áreas.
VehicleEngineType	Tipo de motor del vehículo. Cuando se especifica un modelo de consumo detallado, debe ser coherente con el valor de vehicleEngineType.
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 o regiones. 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 o regiones. vehicleLoadType se puede especificar varias veces. Este parámetro solo se considera actualmente para travelMode=truck.
WindingnessLevel	Nivel de turnos para una ruta emocionante. Este parámetro solo se puede usar junto con `routeType`=thrilling.

AlternativeRouteType

Controla la óptimaidad, con respecto a los criterios de planificación especificados, de las alternativas calculadas en comparación con la ruta de referencia.

Nombre	Tipo	Description
anyRoute	string	Permitir que se devuelva cualquier ruta alternativa independientemente de cómo se compare con la ruta de referencia en términos de óptimaidad.
betterRoute	string	Devuelva una ruta alternativa solo si es mejor que la ruta de referencia según los criterios de planificación especificados.

ComputeTravelTime

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

Nombre	Tipo	Description
all	string	Calcula los tiempos de desplazamiento de todos los tipos de información de tráfico y especifica todos los resultados en los campos noTraffic TravelTimeInSeconds, historicTraffic TravelTimeInSeconds y liveTrafficIncidents TravelTimeInSeconds que se incluyen en los resúmenes de la respuesta de ruta.
none	string	No calcula tiempos de desplazamiento adicionales.

DelayMagnitude

Magnitud del retraso causado por el incidente. Estos valores corresponden a los valores del campo de respuesta ty de get Traffic Incident Detail API.

Nombre	Tipo	Description
0	string	desconocida.
1	string	Secundario.
2	string	Moderado.
3	string	Principal.
4	string	Indefinido, utilizado para cierres de carreteras y otros retrasos indefinidos.

DrivingSide

Indica la conducción a la izquierda frente a la derecha en el punto de la maniobra.

Nombre	Tipo	Description
LEFT	string	Lado izquierdo.
RIGHT	string	Lado derecho.

EffectiveSetting

Parámetro o datos efectivos que se usan al llamar a esta API de ruta.

Nombre	Tipo	Description
key	string	Nombre del parámetro usado.
value	string	Valor del parámetro usado.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

GuidanceInstructionType

Tipo de instrucción, por ejemplo, giro o cambio de forma de carretera.

Nombre	Tipo	Description
DIRECTION_INFO	string	Información de dirección.
LOCATION_ARRIVAL	string	Ubicación de llegada.
LOCATION_DEPARTURE	string	Ubicación de salida.
LOCATION_WAYPOINT	string	Ubicación del punto de acceso.
ROAD_CHANGE	string	Cambio de carretera.
TURN	string	Giro.

GuidanceManeuver

Código que identifica la maniobra.

Nombre	Tipo	Description
ARRIVE	string	Has llegado.
ARRIVE_LEFT	string	Has llegado. El destino está a la izquierda.
ARRIVE_RIGHT	string	Has llegado. El destino está a la derecha.
BEAR_LEFT	string	Oso a la izquierda.
BEAR_RIGHT	string	Oso a la derecha.
DEPART	string	Salir.
ENTER_FREEWAY	string	Tome la autopista.
ENTER_HIGHWAY	string	Tome la autopista.
ENTER_MOTORWAY	string	Tome la autopista.
ENTRANCE_RAMP	string	Tome la rampa.
FOLLOW	string	Seguir.
KEEP_LEFT	string	Manténgase a la izquierda.
KEEP_RIGHT	string	Mantente bien.
MAKE_UTURN	string	Haz un giro.
MOTORWAY_EXIT_LEFT	string	Tome la salida izquierda.
MOTORWAY_EXIT_RIGHT	string	Tome la salida derecha.
ROUNDABOUT_BACK	string	Ve por la rotonda.
ROUNDABOUT_CROSS	string	Cruce la rotonda.
ROUNDABOUT_LEFT	string	En la rotonda, tome la salida a la izquierda.
ROUNDABOUT_RIGHT	string	En la rotonda, tome la salida a la derecha.
SHARP_LEFT	string	Gire a la izquierda afilada.
SHARP_RIGHT	string	Gire a la derecha.
STRAIGHT	string	Sigue adelante.
SWITCH_MAIN_ROAD	string	Cambie a la carretera principal.
SWITCH_PARALLEL_ROAD	string	Cambie a la carretera paralela.
TAKE_EXIT	string	Tome la salida.
TAKE_FERRY	string	Tome el ferry.
TRY_MAKE_UTURN	string	Intenta hacer un giro.
TURN_LEFT	string	Gire a la izquierda.
TURN_RIGHT	string	Gire a la derecha.
WAYPOINT_LEFT	string	Ha llegado al punto de referencia. Está a la izquierda.
WAYPOINT_REACHED	string	Ha llegado al punto de referencia.
WAYPOINT_RIGHT	string	Ha llegado al punto de referencia. Está a la derecha.

InclineLevel

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

Nombre	Tipo	Description
high	string	high
low	string	low
normal	string	normal

JunctionType

Tipo de unión donde tiene lugar la maniobra. En el caso de los redondeos más grandes, se generan dos instrucciones independientes para entrar y salir de la rotonda.

Nombre	Tipo	Description
BIFURCATION	string	Bifurcación
REGULAR	string	normal
ROUNDABOUT	string	Rotonda

LatLongPair

Una ubicación representada como latitud y longitud.

Nombre	Tipo	Description
latitude	number	Latitude (propiedad)
longitude	number	Longitud (propiedad)

Report

Especifica qué datos se deben notificar con fines de diagnóstico. El único valor posible es effectiveSettings. Informa de los parámetros o datos efectivos que se usan al llamar a la API. En el caso de los parámetros predeterminados, el valor predeterminado se reflejará donde el autor de la llamada no especificó el parámetro.

Nombre	Tipo	Description
effectiveSettings	string	Informa de los parámetros o datos efectivos que se usan al llamar a la API.

ResponseFormat

Formato deseado de la respuesta. El valor puede ser json o xml.

Nombre	Tipo	Description
json	string	Formato de intercambio de datos de notación de objetos JavaScript
xml	string	Lenguaje de marcado extensible

ResponseSectionType

Tipos de sección de la respuesta de ruta notificada

Nombre	Tipo	Description
CARPOOL	string	Secciones de la ruta que requieren el uso de carpool (vehículo de alta ocupación) carriles.
CAR_TRAIN	string	Secciones de la ruta que son coches o trenes.
COUNTRY	string	Secciones que indican en qué países o regiones se encuentra la ruta.
FERRY	string	Secciones de la ruta que son ferries.
MOTORWAY	string	Secciones de la ruta que son autopistas.
PEDESTRIAN	string	Secciones de la ruta que solo son adecuadas para los peatones.
TOLL_ROAD	string	Secciones de la ruta que requieren que se pague un peaje.
TOLL_VIGNETTE	string	Secciones de la ruta que requieren que haya una viñeta de peaje.
TRAFFIC	string	Secciones de la ruta que contienen información de tráfico.
TRAVEL_MODE	string	Secciones en relación con el parámetro `travelMode`request .
TUNNEL	string	Secciones de la ruta que son túneles.
URBAN	string	Secciones de la ruta que se encuentran dentro de las zonas urbanas.

ResponseTravelMode

Modo de desplazamiento para la ruta calculada. El valor se establecerá other en si el modo de transporte solicitado no es posible en esta sección.

Nombre	Tipo	Description
bicycle	string	Las rutas devueltas están optimizadas para bicicletas, incluido el uso de carriles de bicicletas.
bus	string	Las rutas devueltas están optimizadas para los autobuses, incluido el uso de solo carriles de autobús. Funcionalidad BETA.
car	string	Las rutas devueltas están optimizadas para automóviles.
motorcycle	string	Las rutas devueltas están optimizadas para motocicletas. Funcionalidad BETA.
other	string	El modo de transporte especificado no es posible en esta sección.
pedestrian	string	Las rutas devueltas están optimizadas para los peatones, incluido el uso de aceras.
taxi	string	Las rutas devueltas están optimizadas para taxis. Funcionalidad BETA.
truck	string	Las rutas devueltas están optimizadas para vehículos comerciales, como para camiones.
van	string	Las rutas devueltas están optimizadas para las camionetas. Funcionalidad BETA.

Route

Nombre	Tipo	Description
guidance	RouteGuidance	Contiene elementos relacionados con la guía. Este campo solo está presente cuando se solicitó la guía y está disponible.
legs	RouteLeg[]	Matriz de piernas
sections	RouteSection[]	Matriz de secciones
summary	RouteSummary	Summary (objeto)

RouteAvoidType

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 de intervalo de rutas, no se debe usar el valor alreadyUsedRoads.

Nombre	Tipo	Description
alreadyUsedRoads	string	Evita el uso de la misma carretera varias veces. Lo más útil junto con `routeType`=emocionante.
borderCrossings	string	Evita los cruces de bordes en el cálculo de rutas.
carpools	string	Evita las rutas que requieren el uso de carriles de carpool (vehículo de alta ocupación/ HOV).
ferries	string	Evita los ferries
motorways	string	Evita autopistas
tollRoads	string	Evita carreteras de peaje.
unpavedRoads	string	Evita carreteras no transitadas

RouteDirections

Este objeto se devuelve desde una llamada a Route Directions correcta.

Nombre	Tipo	Description
formatVersion	string	Format Version (propiedad)
optimizedWaypoints	RouteOptimizedWaypoint[]	Secuencia optimizada de puntos de referencia. Muestra el índice de la secuencia de puntos de acceso proporcionada por el usuario para la lista original y optimizada. Por ejemplo, una respuesta: `<optimizedWaypoints> <waypoint providedIndex="0" optimizedIndex="1"/> <waypoint providedIndex="1" optimizedIndex="2"/> <waypoint providedIndex="2" optimizedIndex="0"/> </optimizedWaypoints>` significa que la secuencia original es [0, 1, 2] y la secuencia optimizada es [1, 2, 0]. Dado que el índice comienza por 0, el original es "primero, segundo, tercero", mientras que el optimizado es "segundo, tercero, primero".
report	RouteReport	Informa de la configuración efectiva usada en la llamada actual.
routes	Route[]	Matriz de rutas

RouteGuidance

Contiene elementos relacionados con la guía. Este campo solo está presente cuando se solicitó la guía y está disponible.

Nombre	Tipo	Description
instructionGroups	RouteInstructionGroup[]	Agrupa una secuencia de elementos de instrucción que están relacionados entre sí.
instructions	RouteInstruction[]	Una lista de instrucciones que describen maniobras.

RouteInstruction

Conjunto de atributos que describen una maniobra, por ejemplo, "Girar a la derecha", "Mantener la izquierda", "Tomar el ferry", "Tomar la autopista", "Llegar".

Nombre	Tipo	Description
combinedMessage	string	Un mensaje legible para la maniobra combinada con el mensaje de la siguiente instrucción. A veces es posible combinar dos instrucciones sucesivas en una sola instrucción, lo que facilita el seguimiento. Cuando este es el caso, la marca possibleCombineWithNext será true. Por ejemplo: `10. Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam 11. Follow Einsteinweg/A10/E22 towards Ring Amsterdam` La marca possibleCombineWithNext en la instrucción 10 es true. Esto indica a los clientes de instrucciones codificadas que se pueden combinar con la instrucción 11. Las instrucciones se combinarán automáticamente para los clientes que solicitan instrucciones legibles. El campo combinedMessage contiene el mensaje combinado: `Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam then follow Einsteinweg/A10/E22 towards Ring Amsterdam.`
countryCode	string	Código de país ISO 3166-1 alfa-3 de 3 caracteres. Por ejemplo, EE. UU.
drivingSide	DrivingSide	Indica la conducción de la izquierda frente a la derecha en el punto de la maniobra.
exitNumber	string	Los números de una salida de la autopista tomadas por la maniobra actual. Si una salida tiene varios números de salida, se separarán por "," y posiblemente se agregarán por "-", por ejemplo, "10, 13-15".
instructionType	GuidanceInstructionType	Tipo de instrucción, por ejemplo, giro o cambio de forma de carretera.
junctionType	JunctionType	Tipo de unión donde tiene lugar la maniobra. En el caso de las redondeos más grandes, se generan dos instrucciones independientes para entrar y salir de la rotonda.
maneuver	GuidanceManeuver	Código que identifica la maniobra.
message	string	Un mensaje legible para la maniobra.
point	LatLongPair	Una ubicación representada como latitud y longitud.
pointIndex	integer	Índice del punto de la lista de "puntos" de polilínea correspondiente al punto de la instrucción.
possibleCombineWithNext	boolean	Opcionalmente, es posible combinar la instrucción con la siguiente. Esto se puede usar para crear mensajes como "Girar a la izquierda y, a continuación, girar a la derecha".
roadNumbers	string[]	Los números de carretera de los siguientes segmentos significativos de carretera después de la maniobra, o de las carreteras que se van a seguir. Ejemplo: ["E34", "N205"]
roundaboutExitNumber	string	Esto indica la salida que se va a tomar en una rotonda.
routeOffsetInMeters	integer	Distancia desde el inicio de la ruta hasta el punto de la instrucción.
signpostText	string	Texto sobre un signo que es más relevante para la maniobra, o hacia la dirección que se debe seguir.
stateCode	string	Una subdivisión (por ejemplo, estado) del país, representada por la segunda parte de un código ISO 3166-2 . Esto solo está disponible para algunos países o regiones como Estados Unidos, Canadá y México.
street	string	Nombre de la calle del siguiente segmento significativo de carretera después de la maniobra, o de la calle que se debe seguir.
travelTimeInSeconds	integer	Tiempo de viaje estimado hasta el punto correspondiente a routeOffsetInMeters.
turnAngleInDecimalDegrees	integer	Indica la dirección de una instrucción. Si junctionType indica una instrucción turn: 180 = U-turn [-179, -1] = Giro a la izquierda 0 = Recto en (un giro de '0 grados') [1, 179] = Giro derecho Si junctionType indica una instrucción de bifurcación: <0 - mantener a la izquierda >0 - mantener la derecha

RouteInstructionGroup

Agrupa una secuencia de elementos de instrucción que están relacionados entre sí. El intervalo de secuencia está restringido con firstInstructionIndex y lastInstructionIndex. Cuando se solicitan mensajes de texto legibles para instrucciones (instructionType=text o etiquetados), el elemento instructionGroup tiene un mensaje de resumen devuelto cuando está disponible.

Nombre	Tipo	Description
firstInstructionIndex	integer	Índice de la primera instrucción de las instrucciones y pertenencia a este grupo.
groupLengthInMeters	integer	Longitud del grupo.
groupMessage	string	Mensaje de resumen cuando se solicitan mensajes de texto legibles para personas para obtener instrucciones (instructionType=text o etiquetados).
lastInstructionIndex	integer	Índice de la última instrucción de las instrucciones y pertenencia a este grupo.

RouteInstructionsType

Si se especifica, se devolverán instrucciones de instrucciones. Tenga en cuenta que el parámetro instructionsType no se puede usar junto con routeRepresentation=none

Nombre Tipo Description

coded

Nombre	Tipo	Description
coded	string	Devuelve datos de instrucción sin procesar sin mensajes legibles.
tagged	string	Devuelve datos de instrucción sin procesar con mensajes etiquetados legibles para permitir el formato. Un mensaje legible se crea a partir de elementos identificados repetibles. Se etiquetan para permitir que las aplicaciones cliente les dé formato correctamente. Los siguientes componentes de mensaje se etiquetan cuando instructionsType=tagged: street, roadNumber, signpostText, exitNumber, roundaboutExitNumber. Ejemplo de mensaje etiquetado "Turn left": `Turn left onto <roadNumber>A4</roadNumber>/<roadNumber>E19</roadNumber> towards <signpostText>Den Haag</signpostText>`
text	string	Devuelve datos de instrucciones sin procesar con mensajes legibles en texto sin formato.

string

Devuelve datos de instrucción sin procesar sin mensajes legibles.

tagged

string

Devuelve datos de instrucción sin procesar con mensajes etiquetados legibles para permitir el formato. Un mensaje legible se crea a partir de elementos identificados repetibles. Se etiquetan para permitir que las aplicaciones cliente les dé formato correctamente. Los siguientes componentes de mensaje se etiquetan cuando instructionsType=tagged: street, roadNumber, signpostText, exitNumber, roundaboutExitNumber.

Ejemplo de mensaje etiquetado "Turn left":

Turn left onto <roadNumber>A4</roadNumber>/<roadNumber>E19</roadNumber>
towards <signpostText>Den Haag</signpostText>

text

string

Devuelve datos de instrucciones sin procesar con mensajes legibles en texto sin formato.

RouteLeg

Descripción de una parte de una ruta, formada por una lista de puntos. Cada punto de referencia adicional proporcionado en la solicitud dará como resultado una etapa adicional en la ruta devuelta.

Nombre	Tipo	Description
points	LatLongPair[]	Matriz de puntos
summary	RouteLegSummary	Objeto de resumen para la sección de ruta.

RouteLegSummary

Objeto de resumen para la sección de ruta.

Nombre	Tipo	Description
arrivalTime	string	Hora estimada de llegada para la ruta o pierna. La hora es UTC.
batteryConsumptionInkWh	number	Consumo estimado de energía eléctrica en horas de kilowatt (kWh) mediante el modelo de consumo eléctrico. Incluido si vehicleEngineType se establece en electric y constantSpeedConsumptionInkWhPerHundredkm se especifica. El valor de batteryConsumptionInkWh incluye la energía eléctrica recuperada y, por tanto, puede ser negativo (lo que indica la ganancia de energía). Si se especifican maxChargeInkWh y currentChargeInkWh, la recuperación se limitará para garantizar que el nivel de carga de la batería nunca supere maxChargeInkWh. Si no se especifican maxChargeInkWh ni currentChargeInkWh, se asume la recuperación sin restricciones en el cálculo de consumo.
departureTime	string	Hora estimada de salida para la ruta o la pierna. La hora es UTC.
fuelConsumptionInLiters	number	Consumo estimado de combustible en litros con el modelo de consumo de combustión. Incluido si vehicleEngineType se establece en combustión y se especifica constantSpeedConsumptionInLitersPerHundredkm. El valor no será negativo.
historicTrafficTravelTimeInSeconds	integer	Tiempo estimado de viaje calculado mediante datos de tráfico histórico dependientes del tiempo. Solo se incluye si compute TravelTimeFor = todo se usa en la consulta.
lengthInMeters	integer	Length In Meters (propiedad)
liveTrafficIncidentsTravelTimeInSeconds	integer	Tiempo de viaje estimado calculado mediante datos de velocidad en tiempo real. Solo se incluye si compute TravelTimeFor = todo se usa en la consulta.
noTrafficTravelTimeInSeconds	integer	Tiempo estimado de viaje calculado como si no haya retrasos en la ruta debido a condiciones de tráfico (por ejemplo, congestión). Solo se incluye si compute TravelTimeFor = todo se usa en la consulta.
trafficDelayInSeconds	integer	Retraso estimado en segundos causado por los incidentes en tiempo real según la información de tráfico. En el caso de las rutas planeadas con la hora de salida en el futuro, los retrasos siempre son 0. Para devolver tiempos de desplazamiento adicionales con diferentes tipos de información de tráfico, es necesario agregar el parámetro compute TravelTimeFor=all.
travelTimeInSeconds	integer	Tiempo de viaje estimado en segundos propiedad que incluye el retraso debido al tráfico en tiempo real. Tenga en cuenta que incluso cuando traffic=false travelTimeInSeconds todavía incluye el retraso debido al tráfico. Si DepartAt está en el futuro, el tiempo de viaje se calcula mediante datos de tráfico histórico dependientes del tiempo.

RouteOptimizedWaypoint

Objeto de punto de forma optimizado.

Nombre	Tipo	Description
optimizedIndex	integer	Índice de punto de la forma optimizado desde el sistema.
providedIndex	integer	Índice de punto de la forma proporcionado por el usuario.

RouteReport

Informa de la configuración efectiva usada en la llamada actual.

Nombre	Tipo	Description
effectiveSettings	EffectiveSetting[]	Parámetros o datos efectivos que se usan al llamar a esta ROUTE API.

RouteRepresentationForBestOrder

Especifica la representación del conjunto de rutas proporcionadas como respuesta. Este valor de parámetro solo se puede usar junto con computeBestOrder=true.

Nombre	Tipo	Description
none	string	Incluye solo los índices de punto de acceso optimizados, pero no incluye la geometría de ruta en la respuesta.
polyline	string	Incluye geometría de ruta en la respuesta.
summaryOnly	string	Resumen según polilínea, pero sin incluir los elementos de geometría de punto para las rutas de la respuesta.

RouteSection

Las secciones de ruta contienen información adicional sobre partes de una ruta. Cada sección contiene al menos los elementos startPointIndex, endPointIndexy sectionType.

Nombre	Tipo	Description
delayInSeconds	integer	Retraso en segundos causado por el incidente.
effectiveSpeedInKmh	integer	Velocidad efectiva del incidente en km/h, promediada en toda su longitud.
endPointIndex	integer	Índice del último punto (desplazamiento 0) de la ruta a la que se aplica esta sección.
magnitudeOfDelay	DelayMagnitude	Magnitud del retraso causado por el incidente. Estos valores corresponden a los valores del campo de respuesta ty de get Traffic Incident Detail API.
sectionType	ResponseSectionType	Tipos de sección de la respuesta de ruta notificada
simpleCategory	SimpleCategory	Tipo del incidente. Actualmente puede ser JAM, ROAD_WORK, ROAD_CLOSURE u OTRO. Consulte "tec" para obtener información detallada.
startPointIndex	integer	Índice del primer punto (desplazamiento 0) de la ruta a la que se aplica esta sección.
tec	RouteSectionTec	Detalles del evento de tráfico, usando definiciones en el estándar TPEG2-TEC . Puede contener effectCode y provoca elementos.
travelMode	ResponseTravelMode	Modo de desplazamiento para la ruta calculada. El valor se establecerá `other` en si el modo de transporte solicitado no es posible en esta sección.

RouteSectionTec

Detalles del evento de tráfico, usando definiciones en el estándar TPEG2-TEC . Puede contener effectCode y provoca elementos.

Nombre	Tipo	Description
causes	RouteSectionTecCause[]	Causas de la matriz
effectCode	integer	Efecto en el flujo de tráfico. Contiene un valor en la tabla tec001:EffectCode, tal como se define en el estándar TPEG2-TEC . Se puede usar para codificar los eventos de tráfico de color según la gravedad.

RouteSectionTecCause

Causa del evento de tráfico. Puede contener elementos mainCauseCode y subCauseCode. Se puede usar para definir la iconografía y las descripciones.

Nombre	Tipo	Description
mainCauseCode	integer	La causa principal del evento de tráfico. Contiene un valor en la tabla tec002:CauseCode, tal como se define en el estándar TPEG2-TEC .
subCauseCode	integer	Subcadena del evento de tráfico. Contiene un valor en la tabla de causas secundarias definida por mainCauseCode, tal como se define en el estándar TPEG2-TEC .

RouteSummary

Summary (objeto)

Nombre	Tipo	Description
arrivalTime	string	Hora estimada de llegada para la ruta o pierna. La hora es UTC.
departureTime	string	Hora estimada de salida para la ruta o la pierna. La hora es UTC.
lengthInMeters	integer	Length In Meters (propiedad)
trafficDelayInSeconds	integer	Retraso estimado en segundos causado por los incidentes en tiempo real según la información de tráfico. En el caso de las rutas planeadas con la hora de salida en el futuro, los retrasos siempre son 0. Para devolver tiempos de desplazamiento adicionales con diferentes tipos de información de tráfico, es necesario agregar el parámetro compute TravelTimeFor=all.
travelTimeInSeconds	integer	Tiempo de viaje estimado en segundos propiedad que incluye el retraso debido al tráfico en tiempo real. Tenga en cuenta que incluso cuando traffic=false travelTimeInSeconds todavía incluye el retraso debido al tráfico. Si DepartAt está en el futuro, el tiempo de viaje se calcula mediante datos de tráfico histórico dependientes del tiempo.

RouteType

Tipo de ruta solicitada.

Nombre	Tipo	Description
eco	string	Una ruta equilibrada por economía y velocidad.
fastest	string	La ruta más rápida.
shortest	string	La ruta más corta por distancia.
thrilling	string	Incluye carreteras interesantes o desafiantes y utiliza tan pocas autopistas como sea posible. Puede elegir el nivel de giro incluido y también el grado de colina. Consulte los parámetros de pendiente y de pararización para saber cómo establecer esto. Hay un límite de 900 km en rutas planeadas con `routeType`=emocionante

SectionType

Especifica cuáles de los tipos de sección se notifican en la respuesta de ruta.

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

Nombre	Tipo	Description
carTrain	string	Secciones de la ruta que son coches o trenes.
carpool	string	Secciones de la ruta que requieren el uso de carpool (vehículo de alta ocupación) carriles.
country	string	Secciones que indican en qué países o regiones se encuentra la ruta.
ferry	string	Secciones de la ruta que son ferries.
motorway	string	Secciones de la ruta que son autopistas.
pedestrian	string	Secciones de la ruta que solo son adecuadas para los peatones.
tollRoad	string	Secciones de la ruta que requieren que se pague un peaje.
tollVignette	string	Secciones de la ruta que requieren que haya una viñeta de peaje.
traffic	string	Secciones de la ruta que contienen información de tráfico.
travelMode	string	Secciones en relación con el parámetro `travelMode`request .
tunnel	string	Secciones de la ruta que son túneles.
urban	string	Secciones de la ruta que se encuentran dentro de las zonas urbanas.

SimpleCategory

Tipo del incidente. Actualmente puede ser JAM, ROAD_WORK, ROAD_CLOSURE u OTRO. Consulte "tec" para obtener información detallada.

Nombre	Tipo	Description
JAM	string	Atasco.
OTHER	string	Otros.
ROAD_CLOSURE	string	Cierre de carretera.
ROAD_WORK	string	Trabajo en carretera.

TravelMode

Modo de viaje para la ruta solicitada. Si no se define, el valor predeterminado es "car". Tenga en cuenta que es posible que el travelMode solicitado no esté 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 camioneta son funcionalidad BETA. Los datos de restricción completa no están disponibles en todas las áreas.

Nombre	Tipo	Description
bicycle	string	Las rutas devueltas están optimizadas para bicicletas, incluido el uso de carriles de bicicletas.
bus	string	Las rutas devueltas están optimizadas para los autobuses, incluido el uso de solo carriles de autobús. Funcionalidad BETA.
car	string	Las rutas devueltas están optimizadas para automóviles.
motorcycle	string	Las rutas devueltas están optimizadas para motocicletas. Funcionalidad BETA.
pedestrian	string	Las rutas devueltas están optimizadas para los peatones, incluido el uso de aceras.
taxi	string	Las rutas devueltas están optimizadas para taxis. Funcionalidad BETA.
truck	string	Las rutas devueltas están optimizadas para vehículos comerciales, como para camiones.
van	string	Las rutas devueltas están optimizadas para las camionetas. Funcionalidad BETA.

VehicleEngineType

Tipo de motor del vehículo. Cuando se especifica un modelo de consumo detallado, debe ser coherente con el valor de vehicleEngineType.

Nombre	Tipo	Description
combustion	string	Motor de combustión interna.
electric	string	Motor eléctrico.

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 o regiones. 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 o regiones. vehicleLoadType se puede especificar varias veces. Este parámetro solo se considera actualmente para travelMode=truck.

Nombre	Tipo	Description
USHazmatClass1	string	Explosivos
USHazmatClass2	string	Gas comprimido
USHazmatClass3	string	Líquidos inflamables
USHazmatClass4	string	Sólidos inflamables
USHazmatClass5	string	Oxidantes
USHazmatClass6	string	Venenos
USHazmatClass7	string	Material radiactivo
USHazmatClass8	string	Corrosivos
USHazmatClass9	string	Disposiciones adicionales
otherHazmatExplosive	string	Explosivos
otherHazmatGeneral	string	Disposiciones adicionales
otherHazmatHarmfulToWater	string	Perjudicial para el agua

WindingnessLevel

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

Nombre	Tipo	Description
high	string	high
low	string	low
normal	string	normal

Route - Get Route Directions

Parámetros de identificador URI

Encabezado de la solicitud

Respuestas

Seguridad

AADToken

Notas

Scopes

subscription-key

SAS Token

Ejemplos

Successfully retrieve a route between an origin and a destination

Sample Request

Sample Response

Definiciones

AlternativeRouteType

ComputeTravelTime

DelayMagnitude

DrivingSide

EffectiveSetting

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GuidanceInstructionType

GuidanceManeuver

InclineLevel

JunctionType

LatLongPair

Report

ResponseFormat

ResponseSectionType

ResponseTravelMode

Route

RouteAvoidType

RouteDirections

RouteGuidance

RouteInstruction

RouteInstructionGroup

RouteInstructionsType

RouteLeg

RouteLegSummary

RouteOptimizedWaypoint

RouteReport

RouteRepresentationForBestOrder

RouteSection

RouteSectionTec

RouteSectionTecCause

RouteSummary

RouteType

SectionType

SimpleCategory

TravelMode

VehicleEngineType

VehicleLoadType

WindingnessLevel

Recursos adicionales