Route - Post Route Matrix Sync

Servicio:

Maps

Versión de la API:

1.0

Use para obtener una matriz de rutas que muestre el tiempo de viaje y la distancia de todos los pares posibles en una lista de orígenes y destinos, mediante una solicitud sincrónica.

La API de Post Route Matrix Sync es una solicitud de POST HTTP que permite el cálculo de una matriz de resúmenes de ruta para un conjunto de rutas definidas por ubicaciones de origen y destino mediante una única solicitud sincrónica (sincrónica). Para realizar una solicitud asincrónica (asincrónica), consulte Post Route Matrix. Para cada origen determinado, el servicio calcula el costo de enrutamiento desde ese origen a cada destino determinado. El conjunto de orígenes y el conjunto de destinos se pueden considerar como los encabezados de columna y fila de una tabla y cada celda de la tabla contiene los costos de enrutamiento desde el origen hasta el destino de esa celda. Por ejemplo, supongamos que una empresa de entrega de comida tiene 20 conductores y necesitan encontrar el conductor más cercano para recoger la entrega del restaurante. Para resolver este caso de uso, pueden llamar a Matrix Route API.

Para cada ruta, se devuelven los tiempos de viaje y las distancias. Puede usar los costos calculados para determinar qué rutas detalladas se van a calcular mediante Route Directions API.

El tamaño máximo de una matriz para una solicitud asincrónica es 700 y para la solicitud de sincronización se 100 (el número de orígenes multiplicado por el número de destinos).

Enviar solicitud de matriz de ruta sincrónica

Si el escenario requiere solicitudes sincrónicas y el tamaño máximo de la matriz es menor o igual que 100, es posible que desee realizar una solicitud sincrónica. El tamaño máximo de una matriz para esta API es 100 (el número de orígenes multiplicado por el número de destinos). Teniendo en cuenta esa restricción, algunos ejemplos de posibles dimensiones de matriz son: 10x10, 6x8, 9x8 (no es necesario que sea cuadrado).

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}

Enviar solicitud de matriz de ruta asincrónica

La API asincrónica es adecuada para procesar grandes volúmenes de solicitudes de enrutamiento relativamente complejas. Cuando se realiza una solicitud mediante una solicitud asincrónica, el servicio devuelve de forma predeterminada un código de respuesta 202 a lo largo de una dirección URL de redireccionamiento en el campo Ubicación del encabezado de respuesta. Esta dirección URL debe comprobarse periódicamente hasta que los datos de respuesta o la información de error estén disponibles. Si waitForResults parámetro de la solicitud se establece en true, el usuario obtendrá una respuesta de 200 si la solicitud ha finalizado en menos de 120 segundos.

El tamaño máximo de una matriz para esta API es 700 (el número de orígenes multiplicado por el número de destinos). Teniendo en cuenta esa restricción, los ejemplos de posibles dimensiones de matriz son: 50x10, 10x10, 28x25. 10x70 (no es necesario que sea cuadrado).

Las respuestas asincrónicas se almacenan durante 24 horas. La dirección URL de redireccionamiento devuelve una respuesta 404 si se usa después del período de expiración.

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

Esta es una secuencia típica de operaciones asincrónicas:

1. El cliente envía una solicitud POST de matriz de rutas a Azure Maps

2. El servidor responderá con uno de los siguientes elementos:

   HTTP 202 Accepted: se ha aceptado la solicitud Route Matrix.

   HTTP Error: se produjo un error al procesar la solicitud route Matrix. Puede ser una solicitud incorrecta 400 o cualquier otro código de estado de error.

3. Si la solicitud de ruta de matriz se aceptó correctamente, el encabezado Location de la respuesta contiene la dirección URL para descargar los resultados de la solicitud. Este URI de estado es similar al siguiente:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

4. El cliente emite una solicitud GET en la dirección URL de descarga obtenida en el paso 3 para descargar los resultados

Descargar resultados de sincronización

Cuando se realiza una solicitud POST para Route Matrix Sync API, el servicio devuelve el código de respuesta 200 para una solicitud correcta y una matriz de respuestas. El cuerpo de la respuesta contendrá los datos y no habrá posibilidad de recuperar los resultados más adelante.

Descargar resultados asincrónicos

Cuando una solicitud emite una respuesta 202 Accepted, la solicitud se procesa mediante nuestra canalización asincrónica. Se le proporcionará una dirección URL para comprobar el progreso de la solicitud asincrónica en el encabezado de ubicación de la respuesta. Este URI de estado es similar al siguiente:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

La dirección URL proporcionada por el encabezado de ubicación devolverá las siguientes respuestas cuando se emita una solicitud de GET.

HTTP 202 Accepted: se aceptó la solicitud de matriz, pero todavía se está procesando. Inténtelo de nuevo en algún momento.

HTTP 200 OK: solicitud de matriz procesada correctamente. El cuerpo de la respuesta contiene todos los resultados.

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0

Con parámetros opcionales:

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&waitForResults={waitForResults}&computeTravelTimeFor={computeTravelTimeFor}&sectionType={sectionType}&arriveAt={arriveAt}&departAt={departAt}&vehicleAxleWeight={vehicleAxleWeight}&vehicleLength={vehicleLength}&vehicleHeight={vehicleHeight}&vehicleWidth={vehicleWidth}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&windingness={windingness}&hilliness={hilliness}&travelMode={travelMode}&avoid={avoid}&traffic={traffic}&routeType={routeType}&vehicleLoadType={vehicleLoadType}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
format	path	True	JsonFormat	Formato deseado de la respuesta. Solo se admite json formato.
api-version	query	True	string	Número de versión de la API de Azure Maps.
arriveAt	query		string date-time	La fecha y hora de llegada al punto de destino con formato de dateTime valor tal 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-19T16:39:57-08:00 El parámetro arriveAt no se puede usar junto con departAt, minDeviationDistance o minDeviationTime.
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.
computeTravelTimeFor	query		ComputeTravelTime	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	query		string date-time	Fecha y hora de salida del punto de origen con formato de dateTime valor tal como se define en RFC 3339, sección 5.6, con un desplazamiento opcional de zona horaria. 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-19T16:39:57-08:00 No se puede usar el parámetro departAt junto con arriveAt.
hilliness	query		InclineLevel	Grado de colina para la emocionante ruta. Este parámetro solo se puede usar junto con routeType=emocionante.
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 se devuelven las secciones que son adecuadas para los peatones. Se puede especificar varias veces en una solicitud, por ejemplo, "§ionType=carTrain§ionType=pedestrian§ionType=autopista". El valor predeterminado sectionType 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: 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	query		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.
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.
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 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	query		integer	Peso del vehículo en kilogramos.
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.
waitForResults	query		boolean	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	query		WindingnessLevel	Nivel de giros para una ruta emocionante. Este parámetro solo se puede usar junto con routeType=emocionante.

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 Id. de Microsoft Entra. 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 la seguridad del identificador de Entra de Microsoft en Azure Maps, consulte los siguientes artículos de para obtener instrucciones.

Cuerpo de la solicitud

Nombre	Tipo	Description
destinations	GeoJsonMultiPoint	Un tipo de geometría GeoJSON MultiPoint válido. Consulte RFC 7946 para obtener más información.
origins	GeoJsonMultiPoint	Un tipo de geometría GeoJSON MultiPoint válido. Consulte RFC 7946 para obtener más información.

Respuestas

Nombre	Tipo	Description
200 OK	RouteMatrixResult	Solicitud de matriz procesada correctamente. El cuerpo de la respuesta contiene todos los resultados.
Other Status Codes	ErrorResponse	Tiempo de espera: la solicitud tardó más tiempo en finalizar que la cantidad máxima de tiempo definida en la API.
Other Status Codes	ErrorResponse	Error inesperado.

Seguridad

AADToken

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

Para implementar escenarios, se recomienda ver conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para modelar 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 encabezado x-ms-client-id para indicar a qué recurso de Azure Maps solicita acceso la aplicación. Esto se puede adquirir desde la API de administración de Maps.

El 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 id. de Microsoft Entra. * 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, la CLI, los SDK de Azure o las API REST. * El uso de 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 la plataforma de identidad de Microsoft, consulte introducción a la plataforma de identidad de Microsoft.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

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

subscription-key

Se trata de una clave compartida que se aprovisiona al Creación de una cuenta de Azure Maps en 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.

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

Tipo: apiKey
En: query

SAS Token

Se crea un token de firma de acceso compartido 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 tiene autorización para acceder a los controles de acceso basados en rol de Azure y el control específico a 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 controle 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 cuenta de mapa de limitar el abuso de representación y renovar periódicamente el token de SAS.

Tipo: apiKey
En: header

Ejemplos

Successfully retrieve a route matrix request result synchronously

Solicitud de ejemplo

HTTP

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&routeType=shortest

{
  "origins": {
    "type": "MultiPoint",
    "coordinates": [
      [
        4.85106,
        52.36006
      ],
      [
        4.85056,
        52.36187
      ]
    ]
  },
  "destinations": {
    "type": "MultiPoint",
    "coordinates": [
      [
        4.85003,
        52.36241
      ],
      [
        13.42937,
        52.50931
      ]
    ]
  }
}

Respuesta de muestra

status code:

200

{
  "formatVersion": "0.0.1",
  "matrix": [
    [
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 495,
            "travelTimeInSeconds": 134,
            "trafficDelayInSeconds": 0,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-27T22:57:43+00:00"
          }
        }
      },
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 647651,
            "travelTimeInSeconds": 26835,
            "trafficDelayInSeconds": 489,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-28T06:22:44+00:00"
          }
        }
      }
    ],
    [
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 338,
            "travelTimeInSeconds": 104,
            "trafficDelayInSeconds": 0,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-27T22:57:13+00:00"
          }
        }
      },
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 647494,
            "travelTimeInSeconds": 26763,
            "trafficDelayInSeconds": 469,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-28T06:21:32+00:00"
          }
        }
      }
    ]
  ],
  "summary": {
    "successfulRoutes": 4,
    "totalRoutes": 4
  }
}

status code:

408

{
  "error": {
    "code": "408 Timeout",
    "message": "Timeout: The request took longer to finish than the maximum amount of time defined in the api."
  }
}

Definiciones

Nombre	Description
ComputeTravelTime	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.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
GeoJsonMultiPoint	Un tipo de geometría GeoJSON MultiPoint válido. Consulte RFC 7946 para obtener más información.
InclineLevel	Grado de colina para la emocionante ruta. Este parámetro solo se puede usar junto con routeType=emocionante.
JsonFormat	Formato deseado de la respuesta. Solo se admite json formato.
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.
RouteLegSummary	Objeto de resumen para la sección de ruta.
RouteMatrix	Objeto de resultado de matriz
RouteMatrixQuery	Objeto con una matriz de coordenadas.
RouteMatrixResult	Este objeto se devuelve de una llamada a Route Matrix correcta. Por ejemplo, si se proporcionan 2 orígenes y 3 destinos, habrá 2 matrices con 3 elementos en cada uno. El contenido de cada elemento depende de las opciones proporcionadas en la consulta.
RouteMatrixResultResponse	Objeto response de la celda actual de la matriz de entrada.
RouteMatrixSummary	Summary (objeto)
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 puede especificar varias veces en una solicitud, por ejemplo, "§ionType=carTrain§ionType=pedestrian§ionType=autopista". El valor predeterminado sectionType hace referencia a la entrada travelMode. De forma predeterminada travelMode está establecido en coche
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.
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 giros para una ruta emocionante. Este parámetro solo se puede usar junto con routeType=emocionante.

ComputeTravelTime

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.

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 noTrafficAdvisorTimeInSeconds, historicTrafficAdvisorTimeInSeconds y liveTrafficIncidentsEventTimeInSeconds que se incluyen en los resúmenes de la respuesta de ruta.
none	string	No calcula tiempos de desplazamiento adicionales.

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[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

GeoJsonMultiPoint

Un tipo de geometría GeoJSON MultiPoint válido. Consulte RFC 7946 para obtener más información.

Nombre	Tipo	Description
coordinates	number[]	Coordenadas de la geometría GeoJson MultiPoint.
type	string: MultiPoint	Especifica el tipo de GeoJSON. Debe ser uno de los nueve tipos de objeto GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

InclineLevel

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

Nombre	Tipo	Description
high	string	Alto
low	string	Bajo
normal	string	normal

JsonFormat

Formato deseado de la respuesta. Solo se admite json formato.

Nombre	Tipo	Description
json	string	el formato de intercambio de datos de notación de objetos JavaScript

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 usar 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 la cola de coches (vehículo de alta ocupación) de los carriles.
ferries	string	Evita los ferris
motorways	string	Evita las autopistas
tollRoads	string	Evita las carreteras de peaje.
unpavedRoads	string	Evita carreteras sin pintar

RouteLegSummary

Objeto de resumen para la sección de ruta.

Nombre	Tipo	Description
arrivalTime	string	Hora estimada de llegada para la ruta o la pierna. La hora está en UTC.
batteryConsumptionInkWh	number	Consumo estimado de energía eléctrica en kilowatt hours (kWh) utilizando el modelo de consumo eléctrico. Se incluye 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 obtención de energía). Si se especifican maxChargeInkWh y currentChargeInkWh, se limitará la recuperación para asegurarse de 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 del consumo.
departureTime	string	Hora estimada de salida para la ruta o la pierna. La hora está en UTC.
fuelConsumptionInLiters	number	Consumo estimado de combustible en litros utilizando el modelo de consumo de combustión. Se incluye si vehicleEngineType se establece en de 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 computeAdvisorTimeFor = todo se usa en la consulta.
lengthInMeters	integer	Length In Meters (propiedad)
liveTrafficIncidentsTravelTimeInSeconds	integer	Tiempo estimado de viaje calculado mediante datos de velocidad en tiempo real. Solo se incluye si computeAdvisorTimeFor = todo se usa en la consulta.
noTrafficTravelTimeInSeconds	integer	Tiempo estimado de viaje calculado como si no hay retrasos en la ruta debido a condiciones de tráfico (por ejemplo, congestión). Solo se incluye si computeAdvisorTimeFor = 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 mediante diferentes tipos de información de tráfico, es necesario agregar el parámetro computeAdvisorTimeFor=all.
travelTimeInSeconds	integer	Tiempo estimado de viaje 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 con datos de tráfico histórico dependientes del tiempo.

RouteMatrix

Objeto de resultado de matriz

Nombre	Tipo	Description
response	RouteMatrixResultResponse	Objeto response de la celda actual de la matriz de entrada.
statusCode	integer	Propiedad StatusCode para la celda actual de la matriz de entrada.

RouteMatrixQuery

Objeto con una matriz de coordenadas.

Nombre	Tipo	Description
destinations	GeoJsonMultiPoint	Un tipo de geometría GeoJSON MultiPoint válido. Consulte RFC 7946 para obtener más información.
origins	GeoJsonMultiPoint	Un tipo de geometría GeoJSON MultiPoint válido. Consulte RFC 7946 para obtener más información.

RouteMatrixResult

Este objeto se devuelve de una llamada a Route Matrix correcta. Por ejemplo, si se proporcionan 2 orígenes y 3 destinos, habrá 2 matrices con 3 elementos en cada uno. El contenido de cada elemento depende de las opciones proporcionadas en la consulta.

Nombre	Tipo	Description
formatVersion	string	Propiedad Format Version
matrix	RouteMatrix[]	Resultados como una matriz dimensional 2 de resúmenes de ruta.
summary	RouteMatrixSummary	Summary (objeto)

RouteMatrixResultResponse

Objeto response de la celda actual de la matriz de entrada.

Nombre	Tipo	Description
routeSummary	RouteLegSummary	Objeto de resumen para la sección de ruta.

RouteMatrixSummary

Summary (objeto)

Nombre	Tipo	Description
successfulRoutes	integer	Número de rutas correctas en la respuesta.
totalRoutes	integer	Número total de rutas solicitadas. Número de celdas de la matriz de entrada.

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 colina y desplazamiento para saber cómo establecer esto. Hay un límite de 900 km en las rutas planeadas con routeType=emocionante

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 puede especificar varias veces en una solicitud, por ejemplo, "§ionType=carTrain§ionType=pedestrian§ionType=autopista". 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 HOV/vehículos de alta ocupación).
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 de solicitud travelMode.
tunnel	string	Secciones de la ruta que son túneles.
urban	string	Secciones de la ruta que se encuentran dentro de las zonas urbanas.

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.

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 las 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.

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	Radiactivo
USHazmatClass8	string	Corrosivos
USHazmatClass9	string	Misceláneo
otherHazmatExplosive	string	Explosivos
otherHazmatGeneral	string	Misceláneo
otherHazmatHarmfulToWater	string	Perjudicial para el agua

WindingnessLevel

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

Nombre	Tipo	Description
high	string	Alto
low	string	Bajo
normal	string	normal