Route - Post Directions Batch

Referencia

Servicio:: Maps

Versión de la API:: 2023-10-01-preview

Use para enviar un lote de consultas a Route Directions API en una única solicitud sincrónica.

La Route Directions Batch API es una solicitud HTTP POST que envía lotes de hasta 100 consultas en una sola llamada a Route Directions API.

Importante

Al usar esta característica, acepta los términos legales de versión preliminar. Consulte los Términos complementarios de la versión preliminar para obtener más detalles.

Enviar solicitud por lotes sincrónica

Se recomienda la API sincrónica para las solicitudes por lotes ligeras. Cuando el servicio recibe una solicitud, responderá en cuanto se calculen los elementos por lotes y no habrá posibilidad de recuperar los resultados más adelante. La API sincrónica devolverá un error de tiempo de espera (una respuesta 408) si la solicitud tarda más de 60 segundos. El número de elementos por lotes está limitado a 100 para esta API.

POST https://atlas.microsoft.com/route/directions:batch?api-version=2023-10-01-preview

Cuerpo POST para la solicitud por lotes

Para enviar las consultas de direcciones, usará una POST solicitud en la que el cuerpo de la solicitud contendrá la batchItems matriz en formato y el Content-Type encabezado se establecerá application/jsonen json . Este es un cuerpo de solicitud de ejemplo que contiene dos consultas de direcciones :

{
  "batchItems": [
    {
      "optionalId": "bbc9c0f6-ab52-49d8-a788-a658fa654c94",
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.3368,
              47.614988
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 0,
            "pointType": "waypoint"
          }
        },
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.316067,
              47.606356
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 1,
            "pointType": "waypoint"
          }
        }
      ],
      "optimizeRoute": "fastestWithoutTraffic",
      "routeOutputOptions": [
        "routeSummary"
      ],
      "maxRouteCount": 3,
      "travelMode": "driving"
    },
    {
      "optionalId": "a191de3c-1268-4986-98f0-03f0a5d9302a",
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.3368,
              47.614988
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 0,
            "pointType": "waypoint"
          }
        },
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.316067,
              47.606356
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 1,
            "pointType": "waypoint"
          }
        }
      ],
      "optimizeRoute": "shortest",
      "routeOutputOptions": [
        "routeSummary"
      ],
      "maxRouteCount": 2,
      "travelMode": "driving"
    }
  ]
}

Un objeto batchItem de indicaciones puede aceptar cualquiera de las direcciones admitidasCuerpo de la solicitud

El lote debe contener al menos 1 consulta.

Modelo de respuesta por lotes

La respuesta por lotes contiene un summary componente que indica que totalRequests formaron parte de la solicitud por lotes original y successfulRequests es decir, consultas que se ejecutaron correctamente. La respuesta por lotes también incluye una batchItems matriz que contiene una respuesta para cada consulta de la solicitud por lotes. batchItems contendrá los resultados en el mismo orden en que se enviaron las consultas originales en la solicitud por lotes. Cada elemento es de uno de los siguientes tipos:

DirectionsResponse : si la consulta se completó correctamente.
Error : si se produjo un error en la consulta. La respuesta contendrá y code en message este caso.

POST https://atlas.microsoft.com/route/directions:batch?api-version=2023-10-01-preview

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
api-version	query	True	string	Número de versión de la API de Azure Maps.

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.

Cuerpo de la solicitud

Nombre	Tipo	Description
batchItems	DirectionsBatchRequestItem[]	Lista de consultas que se van a procesar.

Respuestas

Nombre	Tipo	Description
200 OK	DirectionsBatchResponse	Solicitud por lotes procesada correctamente. El cuerpo de la respuesta contiene todos los resultados por lotes.
Other Status Codes	DirectionsBatchResponse	Estado múltiple. No se pudieron procesar uno o varios elementos por lotes y devolver código de estado diferente.
Other Status Codes	MapsErrorResponse	Se ha producido un error inesperado. Encabezados x-ms-error-code: string

Nombre

Tipo

Description

200 OK

DirectionsBatchResponse

Solicitud por lotes procesada correctamente. El cuerpo de la respuesta contiene todos los resultados por lotes.

Other Status Codes

DirectionsBatchResponse

Estado múltiple. No se pudieron procesar uno o varios elementos por lotes y devolver código de estado diferente.

Other Status Codes

MapsErrorResponse

Se ha producido un error inesperado.

Encabezados

x-ms-error-code: string

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.

Nota

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.

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 crear un recurso de Azure Maps a través del plano de administración de Azure a través de Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST.

Con esta clave, cualquier aplicación está autorizada para acceder a todas las API REST. En otras palabras, estos se pueden tratar actualmente como claves maestras para la cuenta para la que se emiten.

Para las aplicaciones expuestas públicamente, nuestra recomendación es usar el acceso de servidor a servidor de Azure Maps API REST donde esta clave se puede almacenar de forma segura.

Tipo: apiKey
En: header

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.

Tipo: apiKey
En: header

Ejemplos

A Route Directions Batch request containing 2 queries

Solicitud de ejemplo

HTTP

POST https://atlas.microsoft.com/route/directions:batch?api-version=2023-10-01-preview

{
  "batchItems": [
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.3368,
              47.614988
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 0,
            "pointType": "waypoint"
          }
        },
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.316067,
              47.606356
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 1,
            "pointType": "waypoint"
          }
        }
      ],
      "optimizeRoute": "fastestWithTraffic",
      "routeOutputOptions": [
        "routeSummary"
      ],
      "maxRouteCount": 3,
      "travelMode": "driving"
    },
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.3368,
              47.614988
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 0,
            "pointType": "waypoint"
          }
        },
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.316067,
              47.606356
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 1,
            "pointType": "waypoint"
          }
        }
      ],
      "optimizeRoute": "fastestWithTraffic",
      "routeOutputOptions": [
        "routeSummary"
      ],
      "maxRouteCount": 3,
      "travelMode": "driving"
    }
  ]
}

Respuesta de muestra

status code:: 200

{
  "summary": {
    "successfulRequests": 2,
    "totalRequests": 2
  },
  "batchItems": [
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "type": "MultiLineString",
            "coordinates": []
          },
          "properties": {
            "type": "RoutePath",
            "resourceId": "v70,h1207959581,i0,a0,cen-US,dAMA8xD0s2wg1,y1,s1,m1,o1,t0,wWrdB7bfOR0C9UpYhjpVewA2~AJEAEzSxZiQBAADgAYsYlD4B0~N3RoIEF2ZQ2~~~~~~~~v12,w393KEp3NR0ASFhVxOpRewA2~AJEAEzQ5viQBAADgAaehWT4B0~RSBKZWZmZXJzb24gU3Q1~~~~~~~~v12,k0,n2",
            "distanceInMeters": 1432.9,
            "durationInSeconds": 524,
            "durationTrafficInSeconds": 554
          }
        }
      ],
      "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
    },
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "type": "MultiLineString",
            "coordinates": []
          },
          "properties": {
            "type": "RoutePath",
            "resourceId": "v70,h1207959581,i0,a0,cen-US,dAMA8xD0s2wg1,y1,s1,m1,o1,t0,wWrdB7bfOR0C9UpYhjpVewA2~AJEAEzSxZiQBAADgAYsYlD4B0~N3RoIEF2ZQ2~~~~~~~~v12,w393KEp3NR0ASFhVxOpRewA2~AJEAEzQ5viQBAADgAaehWT4B0~RSBKZWZmZXJzb24gU3Q1~~~~~~~~v12,k0,n2",
            "distanceInMeters": 1432.9,
            "durationInSeconds": 524,
            "durationTrafficInSeconds": 554
          }
        }
      ],
      "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
    }
  ]
}

status code:: 207

{
  "summary": {
    "successfulRequests": 1,
    "totalRequests": 2
  },
  "batchItems": [
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "type": "MultiLineString",
            "coordinates": []
          },
          "properties": {
            "type": "RoutePath",
            "resourceId": "v70,h1207959581,i0,a0,cen-US,dAMA8xD0s2wg1,y1,s1,m1,o1,t0,wWrdB7bfOR0C9UpYhjpVewA2~AJEAEzSxZiQBAADgAYsYlD4B0~N3RoIEF2ZQ2~~~~~~~~v12,w393KEp3NR0ASFhVxOpRewA2~AJEAEzQ5viQBAADgAaehWT4B0~RSBKZWZmZXJzb24gU3Q1~~~~~~~~v12,k0,n2",
            "distanceInMeters": 1432.9,
            "durationInSeconds": 524,
            "durationTrafficInSeconds": 554
          }
        }
      ],
      "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
    },
    {
      "error": {
        "code": "400 BadRequest",
        "message": "Invalid request"
      }
    }
  ]
}

Definiciones

Nombre	Description
AdminDistrict	Nombre de subdivisión en el país o región de una dirección. Este elemento se trata normalmente como la subdivisión administrativa de primer orden, pero en algunos casos también contiene la segunda, tercera o cuarta subdivisión de orden en un país, dependencia o región.
Avoid	Especifica restricciones que el cálculo de ruta debe respetar al determinar la ruta. Evite admitir varios valores en una solicitud y solo se admite para la conducción y el travelMode del camión. Ejemplo: "avoid": ["limitedAccessHighways", "tolls"]
DirectionsBatchRequestBody	Lista de instrucciones que se van a procesar. La lista puede contener un máximo de 100 consultas y debe contener al menos 1 consulta.
DirectionsBatchRequestItem	Batch Query (objeto)
DirectionsBatchResponse	Este objeto se devuelve desde una llamada correcta al servicio Directions Batch.
DirectionsBatchResponseItem	Elemento de respuesta por lotes
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
FeatureCollection	`GeoJSON` `FeatureCollection` objeto que contiene una lista de características. Para obtener más información, vea RFC 7946, sección 3.3.
FeaturesItem	Objeto de característica GeoJSON que contiene el objeto Geometry y propiedades adicionales de la ruta.
FeaturesItemTypeEnum	Especifica el tipo `GeoJSON`. El único tipo de objeto admitido es Feature. Para obtener más información, consulte RFC 7946.
FeatureTypeEnum	Especifica el tipo `GeoJSON`. El único tipo de objeto admitido es `FeatureCollection`. Para obtener más información, consulte RFC 7946.
GeoJsonPoint	Un tipo de geometría válido `GeoJSON Point` . Consulte RFC 7946 para obtener más información.
Hint	Información adicional que puede resultar útil en el seguimiento de una ruta. Además del texto de la sugerencia, este elemento tiene un atributo hintType que especifica a qué se refiere la sugerencia, como "NextIntersection". Hint es un elemento opcional. `Note`: solo se admite para conducir travelMode.
InputWaypointFeaturesItem	Especifica el punto de entrada y el objeto de característica viaWaypoint `GeoJSON` y las propiedades adicionales. Para obtener más información, consulte RFC 7946.
InputWaypointTypeEnum	Tipo de punto de referencia en la ruta. Puede ser una parada o una ubicación intermedia a la que debe pasar la ruta.
Instruction	Descripción de una maniobra en un conjunto de direcciones.
Leg	Información sobre una sección de una ruta entre dos puntos de referencia. Más información sobre los campos contenidos en una pierna de ruta:
ManeuverPointProperties	Especifica las instrucciones de conducción y propiedades adicionales para cada punto de maniobra en la pierna de ruta.
ManeuverTypeEnum	Tipo de maniobra descrita por esta colección de detalles. La colección de detalles ManeuverType en A puede proporcionar información para una parte de la maniobra descrita por el atributo maneuverType de la instrucción correspondiente. Por ejemplo, el atributo maneuverType de una instrucción puede especificar TurnLeftThenTurnRight como maniobra mientras que los elementos de detalle asociados pueden especificar detalles sobre las maniobras TurnLeft y TurnRight.
MapsErrorDetail	Detalle del error.
MapsErrorResponse	Respuesta de error común para las API de Azure Maps para devolver los detalles de error de las operaciones con errores.
MapsInnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
MultiLineStringGeometry	Especifica el `GeoJSON` objeto Geometry MultiLineString. Para obtener más información, consulte RFC 7946.
OptimizeRoute	Especifica el parámetro que se va a usar para optimizar la ruta. Si no se define, el valor predeterminado es "fastestWithoutTraffic", que devuelve la ruta para minimizar el tiempo de desplazamiento sin usar la información de tráfico actual. Ejemplo: "optimizeRoute":"shortest"
Order	Secuencia para visitar los puntos de acceso y viaWaypoints.
PointGeometry	Especifica el `GeoJSON` objeto Point Geometry. Para obtener más información, consulte RFC 7946.
RegionTravelSummary	Resumen de viajes de distancia, tiempo y distancia de peaje por dos tipos de entidad: país (por ejemplo, EE. UU., Canadá) y división administrativa o subregión (por ejemplo, "estado" en EE. UU. y "provincia" en Canadá).
RoadTypeEnum	Tipo de carretera. `Note`: solo se admite para conducir travelMode.
RouteOutputOption	Incluya la información de ruta deseada de la respuesta. De forma predeterminada, el itinerario se incluye en la respuesta. Admite varios valores, como "routeOutputOptions": ["routePath", "region TravelSummary"]
RoutePathPoint	Hace referencia al índice de un punto dentro de una pierna específica de una ruta.
RoutePathProperties	Especifica las propiedades que describen la ruta de acceso de la ruta en la respuesta.
RoutePathRange	Hace referencia al intervalo cubierto por una pierna específica de una ruta o ruta de acceso.
RouteTravelMode	Modo de desplazamiento para la ruta de acceso de ruta en la respuesta.
SideOfStreetEnum	Lado de la calle donde se encuentra el destino en función de la dirección de llegada. Este campo solo se aplica a la última maniobraPoint.
Step	Una pierna de ruta contiene instrucciones paso a paso. Un paso hace referencia a un intervalo de una ruta entre dos maniobras consecutivas.
SubLeg	Información sobre los segmentos de la ruta Leg definidas por los puntos de camino de la ruta Leg y los puntos intermedios a través de waypoints. Por ejemplo, si la ruta Leg tiene dos puntos via-way, además de los puntos de ruta inicial y final, habría tres (3) subcarpetas de ruta.
Summary	Resumen de la solicitud por lotes
TrafficCongestionEnum	Nivel de congestión del tráfico a lo largo de la ruta. `Note`: solo se admite para conducir travelMode
TrafficDataUsedEnum	Tipo de datos de tráfico en tiempo real que se usan para generar la ruta.
TravelMode	Modo de viaje para la ruta solicitada. Si no se define, el valor predeterminado es "conducción" que devuelve la ruta optimizada para automóviles. `Note`: para truck travelMode, es posible que la ruta de camión solicitada no esté disponible para toda la ruta. Cuando la ruta del camión no está disponible para una sección determinada, el elemento travelMode de la respuesta de esa sección será "otro". Ejemplo: "travelMode":"driving"
VehicleLoadType	Tipos de carga que pueden clasificarse como materiales peligrosos y restringidos de algunas carreteras. Los valores de vehicleLoadType disponibles son clases hazmat de EE. UU. 1 a 9, además de clasificaciones genéricas para su uso en otros países. Los valores que comienzan con USHazmat son para el enrutamiento de EE. UU., mientras que otroshazmat deben usarse para todos los demás países. vehicleLoadType admite varios valores en una solicitud.
VehicleSpec	Los atributos del vehículo se especifican dentro de un vehicleSpec. Diferentes regiones pueden tener definiciones diferentes para la clasificación y los tipos de camión, por ejemplo, camión ligero, camión mediano, camión pesado, etc. Para obtener los resultados más precisos de las restricciones de ruta en función de las especificaciones del camión, especifique los atributos del vehículo. `Note`: solo se admite para travelMode de camión.
ViaWaypointProperties	Especifica las propiedades de un `ViaWaypoint` que es un punto de referencia que se debe pasar a través o visitar a lo largo de una ruta o un viaje.
WaypointProperties	Especifica las propiedades de un Waypoint que es una ubicación o punto específico a lo largo de una ruta o un viaje que actúa como referencia o punto de detención.

AdminDistrict

Nombre de subdivisión en el país o región de una dirección. Este elemento se trata normalmente como la subdivisión administrativa de primer orden, pero en algunos casos también contiene la segunda, tercera o cuarta subdivisión de orden en un país, dependencia o región.

Nombre	Tipo	Description
distanceInMeters	number	Distancia total recorrida en metros dentro del distrito administrativo.
durationInSeconds	integer	Tiempo estimado de viaje en segundos que no incluye retrasos en la ruta debido a las condiciones de tráfico.
durationTrafficInSeconds	integer	El tiempo que tarda, en segundos, en viajar un correspondiente `TravelDistance` con las condiciones de tráfico actuales. Este valor se proporciona si `optimizeRoute` incluye consideraciones sobre el tráfico.
longName	string	Nombre largo de una dirección, como Washington.

Avoid

Especifica restricciones que el cálculo de ruta debe respetar al determinar la ruta. Evite admitir varios valores en una solicitud y solo se admite para la conducción y el travelMode del camión.

Ejemplo: "avoid": ["limitedAccessHighways", "tolls"]

Nombre	Tipo	Description
borderCrossings	string	Evita cruzar las fronteras del país en la ruta.
ferries	string	Evita el uso de ferris en la ruta.
limitedAccessHighways	string	Evita el uso de autopistas de acceso limitado en la ruta.
lowEmissionZones	string	Evita zonas de baja emisión en la ruta. `Note`: solo se admite para travelMode de camión.
tollRoads	string	Evita el uso de carreteras de peaje en la ruta.
tunnels	string	Evita el uso de túneles en la ruta. `Note`: solo se admite para travelMode de camión.
unpavedRoads	string	Evita carreteras sin pintar en la ruta. `Note`: solo se admite para travelMode de camión.

DirectionsBatchRequestBody

Lista de instrucciones que se van a procesar. La lista puede contener un máximo de 100 consultas y debe contener al menos 1 consulta.

Nombre	Tipo	Description
batchItems	DirectionsBatchRequestItem[]	Lista de consultas que se van a procesar.

DirectionsBatchRequestItem

Batch Query (objeto)

Nombre	Tipo	Valor predeterminado	Description
arriveAt	string		Fecha y hora de llegada al punto de destino con formato de valor `dateTime` definido por RFC 3339, sección 5.6. Cuando no se especifica un desplazamiento de zona horaria, se supone que utc. El `arriveAt` valor debe estar en el futuro. El `arriveAt` parámetro no se puede usar junto con `departAt`. Ejemplo: "arriveAt": "2023-06-01T09:30:00.000-07:00"
avoid	Avoid[]		Especifica restricciones que el cálculo de ruta debe respetar al determinar la ruta. Evite admitir varios valores en una solicitud y solo se admite para la conducción y el travelMode del camión. Ejemplo: "avoid": ["limitedAccessHighways", "tolls"]
departAt	string		Fecha y hora de salida del punto de origen con formato de `dateTime` valor definido por RFC 3339, sección 5.6. Cuando no se especifica un desplazamiento de zona horaria, se supone que utc. El `departAt` valor debe estar en el futuro en el formato de fecha y hora o ahora valor para establecerlo en la hora actual. Ejemplos: "departAt": "2023-06-01T09:30:00.000-07:00"
features	InputWaypointFeaturesItem[]		Las rutas para conducir y caminar se definen mediante un conjunto de puntos de camino (paradas) y viaWaypoints (ubicaciones intermedias a las que debe pasar la ruta). Puede tener un máximo de 25 puntos de acceso y un máximo de 10 viaWaypoints entre cada conjunto de puntos de camino. La ruta del camión admite hasta 150 puntos de acceso y viaWaypoints no se admiten. Una ruta debe tener un mínimo de 2 puntos de ruta y los puntos iniciales y finales de la ruta no pueden ser viaWaypoints. Tanto el punto de acceso como las ubicaciones viaWaypoint deben especificarse como un objeto de característica De punto GeoJSON válido junto con pointIndex que especifica el orden de las ubicaciones. Para obtener más información sobre el formato GeoJSON, consulte RFC 7946.
heading	integer		El encabezado direccional inicial del vehículo en grados a partir del verdadero Norte y continuando en dirección 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 0-359
maxRouteCount	integer		Número máximo de rutas que se van a devolver. Disponible para los modos de conducción y de viaje de camión. En el caso de las rutas de conducción, este parámetro admite rutas con hasta dos puntos de camino, además del origen y el destino, y no se debe establecer el parámetro avoid. Valor predeterminado: "maxRouteCount":1 Mínimo: "maxRouteCount":1 Máximo: "maxRouteCount":3
optimizeRoute	OptimizeRoute	fastestWithoutTraffic	Especifica el parámetro que se va a usar para optimizar la ruta. Si no se define, el valor predeterminado es "fastestWithoutTraffic", que devuelve la ruta para minimizar el tiempo de desplazamiento sin usar la información de tráfico actual. Ejemplo: "optimizeRoute":"shortest"
optimizeWaypointOrder	boolean	False	Vuelva a ordenar los puntos de ruta mediante un algoritmo heurístico rápido para reducir el costo de ruta especificado con el parámetro optimize. El origen y el destino se excluyen del punto de acceso optimizado y su posición se considera fija. Los valores aceptables son true o false. `Note`: solo se admite para travelMode de camión.
optionalId	string		Identificador de la solicitud que se mostraría en batchItem correspondiente.
routeOutputOptions	RouteOutputOption[]	[ "itinerary" ]	Incluya la información de ruta deseada de la respuesta. De forma predeterminada, el itinerario se incluye en la respuesta. Admite varios valores como "routeOutputOptions": ["routePath", "regionTravelSummary"]
travelMode	TravelMode	driving	Modo de viaje para la ruta solicitada. Si no se define, el valor predeterminado es "conducción" que devuelve la ruta optimizada para automóviles. `Note`: para truck travelMode, es posible que la ruta de camión solicitada no esté disponible para toda la ruta. Cuando la ruta del camión no está disponible para una sección determinada, el elemento travelMode de la respuesta de esa sección será "otro". Ejemplo: "travelMode":"driving"
type	FeatureTypeEnum		Especifica el tipo `GeoJSON`. El único tipo de objeto admitido es `FeatureCollection`. Para obtener más información, consulte RFC 7946.
vehicleSpec	VehicleSpec		Especifica los atributos del vehículo, como el tamaño, el peso, la velocidad máxima, el tipo de carga solo para el enrutamiento de camiones. Esto ayuda a evitar las bajas distancias de puente, las restricciones de carretera, los giros correctos difíciles para proporcionar la ruta optimizada del camión en función de las especificaciones del vehículo. `Note`: solo se admite para travelMode de camión

DirectionsBatchResponse

Este objeto se devuelve desde una llamada correcta al servicio Directions Batch.

Nombre	Tipo	Description
batchItems	DirectionsBatchResponseItem[]	Matriz que contiene los resultados del lote.
nextLink	string	es el vínculo a la página siguiente de las características devueltas. Si es la última página, el campo no existirá.
summary	Summary	Resumen de la solicitud por lotes

DirectionsBatchResponseItem

Elemento de respuesta por lotes

Nombre	Tipo	Description
alternativeRoutes	FeatureCollection[]	Ruta alternativa.
error	ErrorDetail	Detalle del error.
features	FeaturesItem[]	`GeoJSON` objeto feature que contiene el objeto Geometry y propiedades adicionales. Para obtener más información, vea RFC 7946, Sección 3.2.
nextLink	string	es el vínculo a la página siguiente de las características devueltas. Si es la última página, el campo no existirá.
optionalId	string	Identificador de la solicitud que se mostraría en el objeto batchItem correspondiente.
type	FeatureTypeEnum	Especifica el tipo `GeoJSON`. El único tipo de objeto admitido es `FeatureCollection`. Para obtener más información, consulte RFC 7946.

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.

FeatureCollection

GeoJSON FeatureCollection objeto que contiene una lista de características. Para obtener más información, vea RFC 7946, sección 3.3.

Nombre	Tipo	Description
features	FeaturesItem[]	`GeoJSON` objeto feature que contiene el objeto Geometry y propiedades adicionales. Para obtener más información, vea RFC 7946, Sección 3.2.
nextLink	string	es el vínculo a la página siguiente de las características devueltas. Si es la última página, el campo no existirá.
type	FeatureTypeEnum	Especifica el tipo `GeoJSON`. El único tipo de objeto admitido es `FeatureCollection`. Para obtener más información, consulte RFC 7946.

FeaturesItem

Objeto de característica GeoJSON que contiene el objeto Geometry y propiedades adicionales de la ruta.

Nombre	Tipo	Description
bbox	number[]	Un área rectangular en la tierra definida como un objeto de rectángulo delimitador. Los lados de los rectángulos se definen mediante valores de latitud y longitud. Para obtener más información, vea RFC 7946, Sección 5. Ejemplo: "bbox": [-10.0, -10.0, 10.0, 10.0]
geometry	Geometry: MultiLineStringGeometry PointGeometry	Objeto Geometry válido `GeoJSON` . Para obtener más información, consulte RFC 7946.
properties	FeatureProperties: ManeuverPointProperties RoutePathProperties ViaWaypointProperties WaypointProperties	Especifica las propiedades de características de la ruta, como itinerario, piernas de ruta y geometría, resumen de viaje.
type	FeaturesItemTypeEnum	Especifica el tipo `GeoJSON`. El único tipo de objeto admitido es Feature. Para obtener más información, consulte RFC 7946.

FeaturesItemTypeEnum

Especifica el tipo GeoJSON. El único tipo de objeto admitido es Feature. Para obtener más información, consulte RFC 7946.

Nombre	Tipo	Description
Feature	string	Especifica el `GeoJSON` tipo de objeto Feature.

FeatureTypeEnum

Especifica el tipo GeoJSON. El único tipo de objeto admitido es FeatureCollection. Para obtener más información, consulte RFC 7946.

Nombre	Tipo	Description
FeatureCollection	string	Especifica el tipo de `GeoJSONFeatureCollection` objeto.

GeoJsonPoint

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

Nombre	Tipo	Description
coordinates	number[]	A `Position` es una matriz de números con dos o más elementos. Los dos primeros elementos son longitud y latitud, precisamente en ese orden. Altitud/Elevación es un tercer elemento opcional. Consulte RFC 7946 para obtener más información.
type	string: Point	Especifica el tipo `GeoJSON`. Debe ser uno de los nueve tipos de objetos GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

Hint

Información adicional que puede resultar útil en el seguimiento de una ruta. Además del texto de la sugerencia, este elemento tiene un atributo hintType que especifica a qué se refiere la sugerencia, como "NextIntersection". Hint es un elemento opcional. Note: solo se admite para conducir travelMode.

Nombre	Tipo	Description
hintType	string	tipo de sugerencia.
text	string	texto de sugerencia.

InputWaypointFeaturesItem

Especifica el punto de entrada y el objeto de característica viaWaypoint GeoJSON y las propiedades adicionales. Para obtener más información, consulte RFC 7946.

Nombre	Tipo	Valor predeterminado	Description
geometry	GeoJsonPoint: PointGeometry		Un tipo de geometría válido `GeoJSON Point` . Consulte RFC 7946 para obtener más información.
properties.pointIndex	integer		Identifique y ordene la secuencia de puntos de referencia en la ruta. El valor predeterminado es de `index value` una matriz de características.
properties.pointType	InputWaypointTypeEnum	waypoint	Tipo de punto de acceso en la ruta. Puede ser una parada o una ubicación intermedia a la que debe pasar la ruta.
type	FeaturesItemTypeEnum		Especifica el tipo `GeoJSON`. El único tipo de objeto admitido es Feature. Para obtener más información, consulte RFC 7946.

InputWaypointTypeEnum

Tipo de punto de referencia en la ruta. Puede ser una parada o una ubicación intermedia a la que debe pasar la ruta.

Nombre	Tipo	Description
viaWaypoint	string	Un viaWaypoint es un punto de referencia específico que debe pasarse o visitarse a lo largo de una ruta o un viaje. `Note`: solo se admite para conducir travelMode.
waypoint	string	Un punto de referencia es una ubicación o punto específico a lo largo de una ruta o un viaje que actúa como referencia o punto de detención.

Instruction

Descripción de una maniobra en un conjunto de direcciones.

Nombre	Tipo	Description
formattedText	string	Descripción del texto con formato de la instrucción.
hints	Hint[]	Información adicional que puede resultar útil en el seguimiento de una ruta. Además del texto de la sugerencia, este elemento tiene un atributo hintType que especifica a qué se refiere la sugerencia, como "NextIntersection". Hint es un elemento opcional y un paso de ruta puede contener más de una sugerencia. `Note`: solo se admite para conducir travelMode
maneuverType	ManeuverTypeEnum	Tipo de maniobra descrita por esta colección de detalles. La colección de detalles ManeuverType en A puede proporcionar información para una parte de la maniobra descrita por el atributo maneuverType de la instrucción correspondiente. Por ejemplo, el atributo maneuverType de una instrucción puede especificar TurnLeftThenTurnRight como maniobra mientras que los elementos de detalle asociados pueden especificar detalles sobre las maniobras TurnLeft y TurnRight.
text	string	Descripción del texto sin formato de la instrucción.

Leg

Información sobre una sección de una ruta entre dos puntos de referencia. Más información sobre los campos contenidos en una pierna de ruta:

Nombre	Tipo	Description
arrivalTime		La hora estimada de llegada para la pierna, que tiene en cuenta las condiciones de tráfico, tiene el formato de un valor dateTime definido por RFC 3339, sección 5.6. Hará referencia al desplazamiento de zona horaria por `departAt` o `arrivalAt`. Si no es así, se usará la hora UTC.
departureTime		La hora estimada de salida de la pierna, que tiene en cuenta las condiciones de tráfico, tiene el formato de un valor dateTime definido por RFC 3339, sección 5.6. Hará referencia al desplazamiento de zona horaria por `departAt` o `arrivalAt`. Si no es así, se usará la hora UTC.
description	string	Una breve descripción de la ruta.
distanceInMeters	number	Distancia física en metros cubiertos por una pierna de ruta.
durationInSeconds	integer	Tiempo estimado de viaje en segundos que no incluye retrasos en la ruta debido a las condiciones de tráfico.
durationTrafficInSeconds	integer	El tiempo que tarda, en segundos, en viajar un correspondiente `TravelDistance` con las condiciones de tráfico actuales. Este valor se proporciona si `optimizeRoute` incluye consideraciones sobre el tráfico.
regionTravelSummary	RegionTravelSummary	Incluya el resumen de viajes de distancia, tiempo y distancia de peaje por dos tipos de entidad: país (por ejemplo, EE. UU., Canadá) y división administrativa o subregión (por ejemplo, "estado" en EE. UU. y "provincia" en Canadá).
routePathRange	RoutePathRange	Hace referencia al intervalo cubierto por una pierna específica de una ruta o ruta de acceso.
subLegs	SubLeg[]	Información sobre los segmentos de la ruta Leg definidas por los puntos de camino de la ruta Leg y los puntos intermedios a través de waypoints. Por ejemplo, si la ruta Leg tiene dos puntos via-way, además de los puntos de ruta inicial y final, habría tres (3) subcarpetas de ruta.

ManeuverPointProperties

Especifica las instrucciones de conducción y propiedades adicionales para cada punto de maniobra en la pierna de ruta.

Nombre	Tipo	Valor predeterminado	Description
compassDirection	string		Dirección del viaje asociada a una maniobra en una ruta, como sur o suroeste. `Note`: solo se admite para conducir travelMode.
distanceInMeters	number		Distancia física en metros cubiertos por este paso de ruta.
durationInSeconds	integer		Tiempo que tarda, en segundos, en viajar un objeto correspondiente `TravelDistance`.
exitIdentifier	string		Nombre o número de la salida asociada a este paso de ruta.
instruction	Instruction		Descripción de una maniobra en un conjunto de direcciones.
order	Order		Secuencia para visitar los puntos de acceso y viaWaypoints.
routePathPoint	RoutePathPoint		Hace referencia al índice de un punto dentro de una pierna específica de una ruta.
sideOfStreet	SideOfStreetEnum		Lado de la calle donde se encuentra el destino en función de la dirección de llegada. Este campo solo se aplica a la última maniobraPoint.
signs	string[]		Texto de señalización para la ruta. Puede haber más de un valor de signo.
steps	Step[]		Pasos entre dos puntos de maniobra consecutivos.
towardsRoadName	string		Nombre de la calle hacia la que va la ruta en el primer `ManeuverPoint`.
travelMode	RouteTravelMode	driving	Modo de desplazamiento para la ruta de acceso de ruta en la respuesta.
type	string: ManeuverPoint		Tipo de salida.

ManeuverTypeEnum

Tipo de maniobra descrita por esta colección de detalles. La colección de detalles ManeuverType en A puede proporcionar información para una parte de la maniobra descrita por el atributo maneuverType de la instrucción correspondiente. Por ejemplo, el atributo maneuverType de una instrucción puede especificar TurnLeftThenTurnRight como maniobra mientras que los elementos de detalle asociados pueden especificar detalles sobre las maniobras TurnLeft y TurnRight.

Nombre	Tipo	Description
ArriveFinish	string	Llegue al destino final.
ArriveIntermediate	string	Llega a un punto de referencia intermedio.
BearLeft	string	Oso a la izquierda.
BearLeftThenBearLeft	string	El oso se dejó y luego el oso se dejó de nuevo.
BearLeftThenBearRight	string	Oso de izquierda y luego oso derecho.
BearLeftThenTurnLeft	string	Oso a la izquierda y, a continuación, gire a la izquierda.
BearLeftThenTurnRight	string	Oso a la izquierda y luego gire a la derecha.
BearRight	string	Oso bien.
BearRightThenBearLeft	string	Oso a la derecha y luego oso a la izquierda.
BearRightThenBearRight	string	Oso derecho y luego oso de nuevo.
BearRightThenTurnLeft	string	Oso a la derecha y luego gire a la izquierda.
BearRightThenTurnRight	string	Oso a la derecha y luego gire a la derecha.
BearThenKeep	string	Oso la instrucción y, a continuación, una instrucción de mantenimiento
BearThenMerge	string	Oso la instrucción y, a continuación, una instrucción de combinación.
Continue	string	Continúe en la carretera actual.
DepartIntermediateStop	string	Deje un punto intermedio de camino en una dirección diferente y carretera a la que llegó.
DepartIntermediateStopReturning	string	Deje un punto intermedio en la misma dirección y en la misma carretera en la que llegó.
DepartStart	string	Deje el punto de partida.
EnterRoundabout	string	Escriba un redondeo.
EnterThenExitRoundabout	string	Escriba y salga de una rotonda.
ExitRoundabout	string	Salga de una rotonda.
ExitRoundaboutLeft	string	En la rotonda, tome la salida a la izquierda.
ExitRoundaboutRight	string	En la rotonda, tome la salida a la derecha.
Follow	string	Seguir.
GoAroundRoundabout	string	Ve por la rotonda.
KeepLeft	string	Mantente a la izquierda en otra carretera.
KeepOnRampLeft	string	Manténgase a la izquierda y continúe con la rampa.
KeepOnRampRight	string	Manténgase a la derecha y continúe con la rampa.
KeepOnRampStraight	string	Manténgase recto y continúe sobre la rampa.
KeepRight	string	Mantenga la derecha sobre una carretera diferente.
KeepStraight	string	Siga recto en otra carretera.
KeepToStayLeft	string	Mantente a la izquierda para quedarte en la misma carretera.
KeepToStayRight	string	Mantenga el derecho de permanecer en la misma carretera.
KeepToStayStraight	string	Manténgase recto para permanecer en la misma carretera.
MergeFreeway	string	Combinar en una autopista.
MergeHighway	string	Combinar en una autopista.
MergeMotorway	string	Combinar en una autopista.
MotorwayExitLeft	string	Tome la salida izquierda.
MotorwayExitRight	string	Tome la salida correcta.
None	string	Sin instrucciones.
RampThenHighwayLeft	string	Tome la rampa izquierda en la autopista. Esto forma parte de una instrucción combinada.
RampThenHighwayRight	string	Tome la rampa derecha a la autopista. Esto forma parte de una instrucción combinada.
RampThenHighwayStraight	string	Manténgase recto para tomar la rampa en la autopista. Esto forma parte de una instrucción combinada.
RoadNameChange	string	Cambia el nombre del camino.
SwitchToMainRoad	string	Cambie a la carretera principal.
SwitchToParallelRoad	string	Cambie a la carretera paralela.
Take	string	Tome el camino. Esta instrucción se utiliza al entrar o salir de un ferry.
TakeExit	string	Tome la salida.
TakeFerry	string	Tome el ferry.
TakeRamp	string	Toma rampa.
TakeRampLeft	string	Tome rampa a la izquierda.
TakeRampRight	string	Tome rampa a la derecha.
TakeRampStraight	string	Quédate directamente para tomar rampa.
TurnBack	string	Retroceda fuertemente.
TurnLeft	string	Gire a la izquierda.
TurnLeftSharp	string	Tome un giro a la izquierda afilado.
TurnLeftThenBearLeft	string	Gire a la izquierda y luego oso a la izquierda.
TurnLeftThenBearRight	string	Gire a la izquierda y, a continuación, oso a la derecha.
TurnLeftThenTurnLeft	string	Gire a la izquierda y vuelva a girar a la izquierda.
TurnLeftThenTurnRight	string	Gire a la izquierda y, a continuación, gire a la derecha.
TurnRight	string	Gire a la derecha.
TurnRightSharp	string	Tome un giro derecho afilado.
TurnRightThenBearLeft	string	Gire a la derecha y luego oso a la izquierda.
TurnRightThenBearRight	string	Gire a la derecha y luego oso derecho.
TurnRightThenTurnLeft	string	Gire a la derecha y, a continuación, gire a la izquierda.
TurnRightThenTurnRight	string	Gire a la derecha y vuelva a girar a la derecha
TurnThenMerge	string	Instrucción turn seguida de una instrucción de combinación.
TurnToStayLeft	string	Gire a la izquierda para permanecer en la misma carretera.
TurnToStayRight	string	Gire a la derecha para permanecer en la misma carretera.
UTurn	string	Haga un giro para ir en la dirección opuesta.
Unknown	string	La instrucción es desconocida.
Wait	string	Esperar
Walk	string	A pie

MapsErrorDetail

Detalle del error.

Nombre	Tipo	Description
code	string	Uno de los conjuntos de códigos de error definidos por el servidor.
details	MapsErrorDetail[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	MapsInnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.
target	string	Destino del error.

MapsErrorResponse

Respuesta de error común para las API de Azure Maps para devolver los detalles de error de las operaciones con errores.

Nombre	Tipo	Description
error	MapsErrorDetail	Detalle del error.

MapsInnerError

Objeto que contiene información más específica que el objeto actual sobre el error.

Nombre	Tipo	Description
code	string	Código de error.
innererror	MapsInnerError	Objeto que contiene información más específica que el objeto actual sobre el error.

MultiLineStringGeometry

Especifica el GeoJSON objeto Geometry MultiLineString. Para obtener más información, consulte RFC 7946.

Nombre	Tipo	Description
coordinates	number[]	Coordenadas de la `GeoJson MultiLineString` geometría.
type	string: MultiLineString	Especifica el tipo de geometría para el objeto Geometry 'GeoJSON'. Para obtener más información, consulte RFC 7946.

OptimizeRoute

Especifica el parámetro que se va a usar para optimizar la ruta. Si no se define, el valor predeterminado es "fastestWithoutTraffic", que devuelve la ruta para minimizar el tiempo de desplazamiento sin usar la información de tráfico actual.

Ejemplo: "optimizeRoute":"shortest"

Nombre	Tipo	Description
fastestAvoidClosureWithoutTraffic	string	La ruta se calcula para minimizar el tiempo y evitar cierres de carreteras. No se utiliza información de tráfico excepto los cierres de carreteras en el cálculo. `Note`: solo se admite para conducir travelMode.
fastestWithTraffic	string	La ruta se calcula para minimizar el tiempo mediante la información de tráfico actual. `Note`: solo se admite para conducir y camión travelMode.
fastestWithoutTraffic	string	Busca la ruta más rápida, sin tener en cuenta la información de tráfico.
shortest	string	La ruta se calcula para minimizar la distancia. No se usa la información de tráfico.

Order

Secuencia para visitar los puntos de acceso y viaWaypoints.

Nombre	Tipo	Description
inputIndex	integer	Índice proporcionado por el usuario para las entradas waypoint y viaWaypoint.
optimizedIndex	integer	Punto de acceso optimizado para el sistema y el índice viaWaypoint.

PointGeometry

Especifica el GeoJSON objeto Point Geometry. Para obtener más información, consulte RFC 7946.

Nombre	Tipo	Description
coordinates	number[]	Un `Position` es una matriz de números con dos o más elementos. Los dos primeros elementos son longitud y latitud, precisamente en ese orden. Altitud/Elevación es un tercer elemento opcional. Consulte RFC 7946 para obtener más información.
type	string: Point	Especifica el tipo de geometría para el objeto Geometry 'GeoJSON'. Para obtener más información, consulte RFC 7946.

RegionTravelSummary

Resumen de viajes de distancia, tiempo y distancia de peaje por dos tipos de entidad: país (por ejemplo, EE. UU., Canadá) y división administrativa o subregión (por ejemplo, "estado" en EE. UU. y "provincia" en Canadá).

Nombre	Tipo	Description
adminDistricts	AdminDistrict[]	adminDistrict array.
countryRegion	string	Nombre de la región del país.
distanceInMeters	number	Length In Meters (propiedad)
durationInSeconds	integer	Tiempo estimado de viaje en segundos que no incluye retrasos en la ruta debido a las condiciones de tráfico.
durationTrafficInSeconds	integer	El tiempo que tarda, en segundos, en viajar un correspondiente `TravelDistance` con las condiciones de tráfico actuales. Este valor se proporciona si `optimizeRoute` incluye consideraciones sobre el tráfico.

RoadTypeEnum

Tipo de carretera. Note: solo se admite para conducir travelMode.

Nombre	Tipo	Description
Arterial	string	Arterial.
Ferry	string	Ferry.
Highway	string	Carretera.
LimitedAccessHighway	string	LimitedAccessHighway.
MajorRoad	string	MajorRoad.
NotApplicable	string	NotApplicable.
Ramp	string	Rampa.
Street	string	Calle.
WalkingPath	string	WalkingPath.

RouteOutputOption

Incluya la información de ruta deseada de la respuesta. De forma predeterminada, el itinerario se incluye en la respuesta.

Admite varios valores, como "routeOutputOptions": ["routePath", "region TravelSummary"]

Nombre	Tipo	Description
itinerary	string	Incluya instrucciones detalladas en la respuesta. Las instrucciones detalladas se proporcionan como "Puntos de maniobra" y contienen detalles como instrucciones paso a paso.
regionTravelSummary	string	Incluya el resumen de viajes de distancia, tiempo y distancia de carretera de peaje por dos tipos de entidad: país (por ejemplo, EE.UU., Canadá) y división administrativa o subdivisión (por ejemplo, "estado" en ESTADOS UNIDOS y "provincia" en Canadá). `Note`: solo se admite para conducir y caminar travelMode
routePath	string	Incluya una instancia de GeoJSON MultiLineString RFC 7946, sección 3.1.5 que describa la ruta de acceso de la ruta en la respuesta.
routeSummary	string	Incluya solo el tiempo de viaje y la distancia para la ruta, y no proporcione otra información.

RoutePathPoint

Hace referencia al índice de un punto dentro de una pierna específica de una ruta.

Nombre	Tipo	Description
legIndex	integer	El índice route Leg es un número secuencial asignado a cada segmento de la ruta para ayudar a identificar y distinguir entre diferentes segmentos de la ruta.
pointIndex	integer	Índice de un punto dentro de una pierna específica.

RoutePathProperties

Especifica las propiedades que describen la ruta de acceso de la ruta en la respuesta.

Nombre	Tipo	Description
arrivalTime		La hora estimada de llegada para la pierna, que tiene en cuenta las condiciones de tráfico, tiene el formato de un `dateTime` valor definido por RFC 3339, sección 5.6. Hará referencia al desplazamiento de zona horaria por `departAt` o `arrivalAt`. Si no es así, se usará la hora UTC.
departureTime		La hora estimada de salida de la pierna, que tiene en cuenta las condiciones de tráfico, tiene el formato de un `dateTime` valor definido por RFC 3339, sección 5.6. Hará referencia al desplazamiento de zona horaria por `departAt` o `arrivalAt`. Si no es así, se usará la hora UTC.
distanceInMeters	number	Distancia física en metros cubiertos por toda la ruta.
durationInSeconds	integer	Tiempo estimado de viaje en segundos que no incluye retrasos en la ruta debido a las condiciones de tráfico.
durationTrafficInSeconds	integer	El tiempo que tarda, en segundos, en viajar un correspondiente `TravelDistance` con las condiciones de tráfico actuales. Este valor se proporciona si `optimizeRoute` incluye consideraciones sobre el tráfico.
legs	Leg[]	Matriz de piernas de ruta. Consulte la descripción del objeto Route Leg para obtener más información.
resourceId	string	Identificador único del recurso.
trafficCongestion	TrafficCongestionEnum	Nivel de congestión del tráfico a lo largo de la ruta. `Note`: solo se admite para conducir travelMode
trafficDataUsed	TrafficDataUsedEnum	Tipo de datos de tráfico en tiempo real que se usan para generar la ruta.
type	string: RoutePath	Tipo de salida.

RoutePathRange

Hace referencia al intervalo cubierto por una pierna específica de una ruta o ruta de acceso.

Nombre	Tipo	Description
legIndex	integer	El índice route Leg es un número secuencial asignado a cada segmento de la ruta para ayudar a identificar y distinguir entre diferentes segmentos de la ruta.
range	integer[]	Hace referencia al intervalo cubierto por una pierna específica de una ruta o ruta de acceso.

RouteTravelMode

Modo de desplazamiento para la ruta de acceso de ruta en la respuesta.

Nombre	Tipo	Description
driving	string	Rutas optimizadas para automóviles.
other	string	Route TravelMode se devuelve como "otro" para el travelMode del camión cuando la ruta del camión no está disponible para una sección determinada de una ruta.
truck	string	Rutas optimizadas para camiones de gran tamaño en función de la especificación del vehículo.
walking	string	Rutas optimizadas para los peatones.

SideOfStreetEnum

Lado de la calle donde se encuentra el destino en función de la dirección de llegada. Este campo solo se aplica a la última maniobraPoint.

Nombre	Tipo	Description
Left	string	Izquierda.
Right	string	Bien.
Unknown	string	desconocida.

Step

Una pierna de ruta contiene instrucciones paso a paso. Un paso hace referencia a un intervalo de una ruta entre dos maniobras consecutivas.

Nombre	Tipo	Description
compassDegrees	number	Dirección en grados. `Note`: solo se admite para conducir travelMode.
maneuverType	ManeuverTypeEnum	Tipo de maniobra descrita por esta colección de detalles. La colección de detalles ManeuverType en A puede proporcionar información para una parte de la maniobra descrita por el atributo maneuverType de la instrucción correspondiente. Por ejemplo, el atributo maneuverType de una instrucción puede especificar TurnLeftThenTurnRight como maniobra mientras que los elementos de detalle asociados pueden especificar detalles sobre las maniobras TurnLeft y TurnRight.
names	string[]	Calle, autopista o intersección donde se produce la maniobra. Si la maniobra es compleja, puede haber más de un campo de nombre en la colección de detalles. El campo de nombre también puede no tener ningún valor. Esto puede ocurrir si no se conoce el nombre o si una calle, carretera o intersección no tiene un nombre.
roadType	RoadTypeEnum	Tipo de carretera. `Note`: solo se admite para conducir travelMode.
routePathRange	RoutePathRange	Hace referencia al intervalo cubierto por una pierna específica de una ruta o ruta de acceso.

SubLeg

Información sobre los segmentos de la ruta Leg definidas por los puntos de camino de la ruta Leg y los puntos intermedios a través de waypoints. Por ejemplo, si la ruta Leg tiene dos puntos via-way, además de los puntos de ruta inicial y final, habría tres (3) subcarpetas de ruta.

Nombre	Tipo	Description
distanceInMeters	number	Distancia física en metros cubiertos por la sub-pierna.
durationInSeconds	integer	Tiempo estimado de viaje en segundos que no incluye retrasos en la ruta debido a las condiciones de tráfico.
durationTrafficInSeconds	integer	El tiempo que tarda, en segundos, en viajar un correspondiente `TravelDistance` con las condiciones de tráfico actuales. Este valor se proporciona si `optimizeRoute` incluye consideraciones sobre el tráfico.
routePathRange	RoutePathRange	Hace referencia al intervalo cubierto por una pierna específica de una ruta o ruta de acceso.

Summary

Resumen de la solicitud por lotes

Nombre	Tipo	Description
successfulRequests	integer	Número de solicitudes correctas en el lote
totalRequests	integer	Número total de solicitudes en el lote

TrafficCongestionEnum

Nivel de congestión del tráfico a lo largo de la ruta. Note: solo se admite para conducir travelMode

Nombre	Tipo	Description
Heavy	string	Pesado.
Medium	string	Mediana.
Mild	string	Suave.
None	string	Ninguno.
Unknown	string	desconocida.

TrafficDataUsedEnum

Tipo de datos de tráfico en tiempo real que se usan para generar la ruta.

Nombre	Tipo	Description
Closure	string	Datos de cierre en tiempo real usados, si procede.
Flow	string	Velocidades de tráfico en tiempo real usadas para calcular el tiempo de viaje.
FlowAndClosure	string	Flujo y cierre.
None	string	Ninguno.

TravelMode

Modo de viaje para la ruta solicitada. Si no se define, el valor predeterminado es "conducción" que devuelve la ruta optimizada para automóviles.

Note: para truck travelMode, es posible que la ruta de camión solicitada no esté disponible para toda la ruta. Cuando la ruta del camión no está disponible para una sección determinada, el elemento travelMode de la respuesta de esa sección será "otro".

Ejemplo: "travelMode":"driving"

Nombre	Tipo	Description
driving	string	Las rutas devueltas están optimizadas para automóviles.
truck	string	Las rutas devueltas están optimizadas para camiones de gran tamaño en función de la especificación del vehículo.
walking	string	Las rutas devueltas están optimizadas para los peatones, incluido el uso de aceras.

VehicleLoadType

Tipos de carga que pueden clasificarse como materiales peligrosos y restringidos de algunas carreteras. Los valores de vehicleLoadType disponibles son clases hazmat de EE. UU. 1 a 9, además de clasificaciones genéricas para su uso en otros países. Los valores que comienzan con USHazmat son para el enrutamiento de EE. UU., mientras que otroshazmat deben usarse para todos los demás países. vehicleLoadType admite varios valores en una solicitud.

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

VehicleSpec

Los atributos del vehículo se especifican dentro de un vehicleSpec. Diferentes regiones pueden tener definiciones diferentes para la clasificación y los tipos de camión, por ejemplo, camión ligero, camión mediano, camión pesado, etc. Para obtener los resultados más precisos de las restricciones de ruta en función de las especificaciones del camión, especifique los atributos del vehículo.

Note: solo se admite para travelMode de camión.

Nombre	Tipo	Valor predeterminado	Description
axleCount	integer	0	Número de ejes en el vehículo. Un valor de 0 significa que no se tienen en cuenta las restricciones de ejes.
axleWeight	integer	0	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.
height	number	0	Altura del vehículo en metros. Un valor de 0 significa que no se tienen en cuenta las restricciones de altura.
isVehicleCommercial	boolean	False	Si el vehículo se utiliza con fines comerciales. Es posible que los vehículos comerciales no puedan conducir en algunas carreteras.
length	number	0	Longitud del vehículo en metros. Un valor de 0 significa que no se tienen en cuenta las restricciones de longitud.
loadType	VehicleLoadType[]		Tipos de carga que pueden clasificarse como materiales peligrosos y restringidos de algunas carreteras. Los valores de vehicleLoadType disponibles son clases hazmat de EE. UU. 1 a 9, además de clasificaciones genéricas para su uso en otros países. Los valores que comienzan con USHazmat son para el enrutamiento de EE. UU., mientras que otroshazmat deben usarse para todos los demás países. vehicleLoadType admite varios valores en una solicitud.
maxSpeed	integer	0	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.
weight	integer	0	Peso del vehículo en kilogramos. Un valor de 0 significa que no se tienen en cuenta las restricciones de peso.
width	number	0	Ancho del vehículo en metros. Un valor de 0 significa que no se tienen en cuenta las restricciones de ancho.

ViaWaypointProperties

Especifica las propiedades de un ViaWaypoint que es un punto de referencia que se debe pasar a través o visitar a lo largo de una ruta o un viaje.

Nombre	Tipo	Description
names	string[]	Calle, autopista o intersección donde se produce la maniobra. Si la maniobra es compleja, puede haber más de un campo de nombre en la colección de detalles. El campo de nombre también puede no tener ningún valor. Esto puede ocurrir si no se conoce el nombre o si una calle, carretera o intersección no tiene un nombre.
order	Order	Secuencia para visitar los puntos de acceso y viaWaypoints.
routePathPoint	RoutePathPoint	Hace referencia al índice de un punto dentro de una pierna específica de una ruta.
type	string: ViaWaypoint	Tipo de salida.

WaypointProperties

Especifica las propiedades de un Waypoint que es una ubicación o punto específico a lo largo de una ruta o un viaje que actúa como referencia o punto de detención.

Nombre	Tipo	Valor predeterminado	Description
compassDirection	string		Dirección del viaje asociada a una maniobra en una ruta, como sur o suroeste. `Note`: solo se admite para conducir travelMode.
distanceInMeters	number		Distancia física en metros cubiertos por este paso de ruta.
durationInSeconds	integer		Tiempo que tarda, en segundos, en viajar un objeto correspondiente `TravelDistance`.
exitIdentifier	string		Nombre o número de la salida asociada a este paso de ruta.
instruction	Instruction		Descripción de una maniobra en un conjunto de direcciones.
order	Order		Secuencia para visitar los puntos de acceso y viaWaypoints.
routePathPoint	RoutePathPoint		Hace referencia al índice de un punto dentro de una pierna específica de una ruta.
sideOfStreet	SideOfStreetEnum		Lado de la calle donde se encuentra el destino en función de la dirección de llegada. Este campo solo se aplica a la última maniobraPoint.
signs	string[]		Texto de señalización para la ruta. Puede haber más de un valor de signo.
steps	Step[]		Pasos entre dos puntos de maniobra consecutivos.
towardsRoadName	string		Nombre de la calle hacia la que va la ruta en el primer `ManeuverPoint`.
travelMode	RouteTravelMode	driving	Modo de desplazamiento para la ruta de acceso de ruta en la respuesta.
type	string: Waypoint		Tipo de salida.

Compartir a través de

Route - Post Directions Batch

Enviar solicitud por lotes sincrónica

Cuerpo POST para la solicitud por lotes

Modelo de respuesta por lotes

Parámetros de identificador URI

Encabezado de la solicitud

Cuerpo de la solicitud

Respuestas

Seguridad

AADToken

Ámbitos

subscription-key

SAS Token

Ejemplos

A Route Directions Batch request containing 2 queries

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AdminDistrict

Avoid

DirectionsBatchRequestBody

DirectionsBatchRequestItem

DirectionsBatchResponse

DirectionsBatchResponseItem

ErrorAdditionalInfo

ErrorDetail

FeatureCollection

FeaturesItem

FeaturesItemTypeEnum

FeatureTypeEnum

GeoJsonPoint

Hint

InputWaypointFeaturesItem

InputWaypointTypeEnum

Instruction

Leg

ManeuverPointProperties

ManeuverTypeEnum

MapsErrorDetail

MapsErrorResponse

MapsInnerError

MultiLineStringGeometry

OptimizeRoute

Order

PointGeometry

RegionTravelSummary

RoadTypeEnum

RouteOutputOption

RoutePathPoint

RoutePathProperties

RoutePathRange

RouteTravelMode

SideOfStreetEnum

Step

SubLeg

Summary

TrafficCongestionEnum

TrafficDataUsedEnum

TravelMode

VehicleLoadType

VehicleSpec

ViaWaypointProperties

WaypointProperties

Recursos adicionales