Share via

Route - Post Route Directions Batch Sync

  • Referencia
Service:
Maps
API Version:
1.0

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

La Post Route Directions Batch Sync API es una solicitud HTTP POST que envía lotes de consultas a Get Route Directions API mediante una única solicitud sincrónica. Puede llamar Route Directions Batch a la API para que se ejecute de forma asincrónica (asincrónica) o sincrónica (sincrónica). La API asincrónica permite al autor de la llamada procesar por lotes hasta 700 consultas y sincronizar la API hasta 100 consultas. Para llamar a la Post Route Directions Batch API en una solicitud asincrónica, consulte Post Route Directions Batch.

Enviar solicitud por lotes sincrónica

Se recomienda la API sincrónica para solicitudes por lotes ligeras. Cuando el servicio recibe una solicitud, responderá tan pronto como 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/sync/json?api-version=1.0&subscription-key={subscription-key}

Modelo de respuesta por lotes

El contenido de datos devuelto es similar para las solicitudes asincrónicas y de sincronización. Al descargar los resultados de una solicitud por lotes asincrónica, si el lote ha terminado de procesarse, el cuerpo de la respuesta contiene la respuesta por lotes. Esta respuesta por lotes contiene un summary componente que indica que totalRequests formaron parte de la solicitud por lotes original y successfulRequestses decir, las consultas que se ejecutaron correctamente. La respuesta por lotes también incluye una batchItems matriz que contiene una respuesta para cada consulta y 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 de batchItems contiene statusCode y response campos. Cada response elemento de batchItems es de uno de los siguientes tipos:

  • RouteDirections - Si la consulta se completó correctamente.

  • Error - Si se produjo un error en la consulta. La respuesta contendrá un code elemento y en message este caso.

Esta es una respuesta por lotes de ejemplo con un resultado correcto y 1 con errores :

{
    "summary": {
        "successfulRequests": 1,
        "totalRequests": 2
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response": {
                "routes": [
                    {
                        "summary": {
                            "lengthInMeters": 1758,
                            "travelTimeInSeconds": 387,
                            "trafficDelayInSeconds": 0,
                            "departureTime": "2018-07-17T00:49:56+00:00",
                            "arrivalTime": "2018-07-17T00:56:22+00:00"
                        },
                        "legs": [
                            {
                                "summary": {
                                    "lengthInMeters": 1758,
                                    "travelTimeInSeconds": 387,
                                    "trafficDelayInSeconds": 0,
                                    "departureTime": "2018-07-17T00:49:56+00:00",
                                    "arrivalTime": "2018-07-17T00:56:22+00:00"
                                },
                                "points": [
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.34892
                                    },
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.3485
                                    },
                                    {
                                        "latitude": 47.62095,
                                        "longitude": -122.3476
                                    }
                                ]
                            }
                        ],
                        "sections": [
                            {
                                "startPointIndex": 0,
                                "endPointIndex": 40,
                                "sectionType": "TRAVEL_MODE",
                                "travelMode": "bicycle"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
format
 path True

JsonFormat

Formato deseado de la respuesta. Solo se admite el formato json.
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

BatchRequestItem[]

Lista de consultas que se van a procesar.

Respuestas

Nombre Tipo Description
200 OK

RouteDirectionsBatchResult

Aceptar
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

Se ha producido un error inesperado.

Seguridad

AADToken

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

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

Notas

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

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

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

Scopes

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

subscription-key

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

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

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

Type: apiKey
In: query

SAS Token

Se 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 está autorizada para acceder a los controles de acceso basado en rol de Azure y el control específico a la expiración, la tasa y las regiones de uso para el token determinado. En otras palabras, 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 asignación para limitar la representación del abuso y renovar periódicamente el token de SAS.

Type: apiKey
In: header

Ejemplos

Successfully retrieve the route direction batch result synchronously

Sample Request

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

{
  "batchItems": [
    {
      "query": "?query=47.639987,-122.128384:47.621252,-122.184408:47.596437,-122.332000&routeType=fastest&travelMode=car&maxAlternatives=99"
    },
    {
      "query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false"
    },
    {
      "query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest"
    }
  ]
}

Sample Response

Status code:
200 
{
  "batchItems": [
    {
      "statusCode": 400,
      "response": {
        "error": {
          "code": "400 BadRequest",
          "message": "maxAlternatives parameter value should be between 0 and 5 inclusive"
        }
      }
    },
    {
      "statusCode": 200,
      "response": {
        "formatVersion": "0.0.12",
        "routes": [
          {
            "summary": {
              "lengthInMeters": 1754,
              "travelTimeInSeconds": 386,
              "trafficDelayInSeconds": 0,
              "departureTime": "2019-06-21T22:56:23+00:00",
              "arrivalTime": "2019-06-21T23:02:49+00:00"
            },
            "legs": [
              {
                "summary": {
                  "lengthInMeters": 1754,
                  "travelTimeInSeconds": 386,
                  "trafficDelayInSeconds": 0,
                  "departureTime": "2019-06-21T22:56:23+00:00",
                  "arrivalTime": "2019-06-21T23:02:49+00:00"
                },
                "points": [
                  {
                    "latitude": 47.62094,
                    "longitude": -122.34892
                  },
                  {
                    "latitude": 47.62094,
                    "longitude": -122.3485
                  },
                  {
                    "latitude": 47.62095,
                    "longitude": -122.3476
                  },
                  {
                    "latitude": 47.60995,
                    "longitude": -122.34174
                  },
                  {
                    "latitude": 47.61011,
                    "longitude": -122.342
                  }
                ]
              }
            ],
            "sections": [
              {
                "startPointIndex": 0,
                "endPointIndex": 44,
                "sectionType": "TRAVEL_MODE",
                "travelMode": "bicycle"
              }
            ]
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "formatVersion": "0.0.12",
        "routes": [
          {
            "summary": {
              "lengthInMeters": 1772,
              "travelTimeInSeconds": 1276,
              "trafficDelayInSeconds": 0,
              "departureTime": "2019-06-21T22:56:23+00:00",
              "arrivalTime": "2019-06-21T23:17:38+00:00"
            },
            "legs": [
              {
                "summary": {
                  "lengthInMeters": 1772,
                  "travelTimeInSeconds": 1276,
                  "trafficDelayInSeconds": 0,
                  "departureTime": "2019-06-21T22:56:23+00:00",
                  "arrivalTime": "2019-06-21T23:17:38+00:00"
                },
                "points": [
                  {
                    "latitude": 40.75982,
                    "longitude": -73.98493
                  },
                  {
                    "latitude": 40.7601,
                    "longitude": -73.98483
                  },
                  {
                    "latitude": 40.75984,
                    "longitude": -73.98417
                  },
                  {
                    "latitude": 40.76047,
                    "longitude": -73.9837
                  },
                  {
                    "latitude": 40.77095,
                    "longitude": -73.9736
                  },
                  {
                    "latitude": 40.77114,
                    "longitude": -73.97356
                  }
                ]
              }
            ],
            "sections": [
              {
                "startPointIndex": 0,
                "endPointIndex": 47,
                "sectionType": "TRAVEL_MODE",
                "travelMode": "pedestrian"
              }
            ]
          }
        ]
      }
    }
  ],
  "summary": {
    "successfulRequests": 2,
    "totalRequests": 3
  }
}
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
BatchRequest

Este tipo representa el cuerpo de la solicitud para el servicio Batch.
BatchRequestItem

Objeto de solicitud de Batch
DelayMagnitude

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

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

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

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

Detalle del error.
ErrorResponse

Respuesta de error
GuidanceInstructionType

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

Código que identifica la maniobra.
JsonFormat

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

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

Una ubicación representada como latitud y longitud.
Response

Resultado de la consulta. RouteDirections si la consulta se completó correctamente, ErrorResponse de lo contrario.
ResponseSectionType

Tipos de sección de la respuesta de ruta notificada
ResponseTravelMode

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

Un elemento devuelto por la llamada al servicio Route Directions Batch.
RouteDirectionsBatchResult

Este objeto se devuelve de una llamada correcta al servicio Route Directions Batch.
RouteGuidance

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

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

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

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

Objeto de resumen para la sección de ruta.
RouteOptimizedWaypoint

Objeto de punto de forma optimizado.
RouteReport

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

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

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

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

Summary (objeto)
SimpleCategory

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

Resumen de los resultados de la solicitud por lotes

BatchRequest

Este tipo representa el cuerpo de la solicitud para el servicio Batch.

Nombre Tipo Description
batchItems

BatchRequestItem[]

Lista de consultas que se van a procesar.

BatchRequestItem

Objeto de solicitud de Batch

Nombre Tipo Description
query

string

Este parámetro contiene una cadena de consulta utilizada para realizar una operación de geocodificación no estructurada. La cadena de consulta se pasará textualmente a la API de búsqueda para su procesamiento.

DelayMagnitude

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

Nombre Tipo Description
0

string

desconocida.
1

string

Secundario.
2

string

Moderado.
3

string

Principal.
4

string

Sin definir, utilizado para cierres de carreteras y otros retrasos indefinidos.

DrivingSide

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

Nombre Tipo Description
LEFT

string

Lado izquierdo.
RIGHT

string

Lado derecho.

EffectiveSetting

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

Nombre Tipo Description
key

string

Nombre del parámetro usado.
value

string

Valor del parámetro usado.

ErrorAdditionalInfo

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

Nombre Tipo Description
info

object

Información adicional.
type

string

Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.
code

string

Código de error.
details

ErrorDetail[]

Los detalles del error.
message

string

El mensaje de error.
target

string

Destino del error.

ErrorResponse

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de error.

GuidanceInstructionType

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

Nombre Tipo Description
DIRECTION_INFO

string

Información de dirección.
LOCATION_ARRIVAL

string

Ubicación de llegada.
LOCATION_DEPARTURE

string

Ubicación de salida.
LOCATION_WAYPOINT

string

Ubicación del punto de acceso.
ROAD_CHANGE

string

Cambio de carretera.
TURN

string

Giro.

GuidanceManeuver

Código que identifica la maniobra.

Nombre Tipo Description
ARRIVE

string

Has llegado.
ARRIVE_LEFT

string

Has llegado. El destino está a la izquierda.
ARRIVE_RIGHT

string

Has llegado. El destino está a la derecha.
BEAR_LEFT

string

Oso a la izquierda.
BEAR_RIGHT

string

Oso a la derecha.
DEPART

string

Salir.
ENTER_FREEWAY

string

Tome la autopista.
ENTER_HIGHWAY

string

Tome la autopista.
ENTER_MOTORWAY

string

Tome la autopista.
ENTRANCE_RAMP

string

Tome la rampa.
FOLLOW

string

Seguir.
KEEP_LEFT

string

Manténgase a la izquierda.
KEEP_RIGHT

string

Mantente bien.
MAKE_UTURN

string

Haz un giro.
MOTORWAY_EXIT_LEFT

string

Tome la salida izquierda.
MOTORWAY_EXIT_RIGHT

string

Tome la salida derecha.
ROUNDABOUT_BACK

string

Ve por la rotonda.
ROUNDABOUT_CROSS

string

Cruce la rotonda.
ROUNDABOUT_LEFT

string

En la rotonda, tome la salida a la izquierda.
ROUNDABOUT_RIGHT

string

En la rotonda, tome la salida a la derecha.
SHARP_LEFT

string

Gire a la izquierda afilada.
SHARP_RIGHT

string

Gire a la derecha.
STRAIGHT

string

Sigue adelante.
SWITCH_MAIN_ROAD

string

Cambie a la carretera principal.
SWITCH_PARALLEL_ROAD

string

Cambie a la carretera paralela.
TAKE_EXIT

string

Tome la salida.
TAKE_FERRY

string

Tome el ferry.
TRY_MAKE_UTURN

string

Intenta hacer un giro.
TURN_LEFT

string

Gire a la izquierda.
TURN_RIGHT

string

Gire a la derecha.
WAYPOINT_LEFT

string

Ha llegado al punto de referencia. Está a la izquierda.
WAYPOINT_REACHED

string

Ha llegado al punto de referencia.
WAYPOINT_RIGHT

string

Ha llegado al punto de referencia. Está a la derecha.

JsonFormat

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

Nombre Tipo Description
json

string

Formato de intercambio de datos de notación de objetos JavaScript

JunctionType

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

Nombre Tipo Description
BIFURCATION

string

Bifurcación
REGULAR

string

normal
ROUNDABOUT

string

Rotonda

LatLongPair

Una ubicación representada como latitud y longitud.

Nombre Tipo Description
latitude

number

Propiedad Latitude
longitude

number

Longitud (propiedad)

Response

Resultado de la consulta. RouteDirections si la consulta se completó correctamente, ErrorResponse de lo contrario.

Nombre Tipo Description
error

ErrorDetail

Objeto de error.
formatVersion

string

Format Version (propiedad)
optimizedWaypoints

RouteOptimizedWaypoint[]

Secuencia optimizada de puntos de referencia. Muestra el índice de la secuencia de puntos de acceso proporcionada por el usuario para la lista original y optimizada. Por ejemplo, una respuesta:

<optimizedWaypoints>
<waypoint providedIndex="0" optimizedIndex="1"/>
<waypoint providedIndex="1" optimizedIndex="2"/>
<waypoint providedIndex="2" optimizedIndex="0"/>
</optimizedWaypoints>

significa que la secuencia original es [0, 1, 2] y la secuencia optimizada es [1, 2, 0]. Dado que el índice comienza por 0, el original es "primero, segundo, tercero", mientras que el optimizado es "segundo, tercero, primero".
report

RouteReport

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

Route[]

Matriz de rutas

ResponseSectionType

Tipos de sección de la respuesta de ruta notificada

Nombre Tipo Description
CARPOOL

string

Secciones de la ruta que requieren el uso de carpool (vehículo de alta ocupación HOV/ vehículos de alta ocupación).
CAR_TRAIN

string

Secciones de la ruta que son coches o trenes.
COUNTRY

string

Secciones que indican en qué países o regiones se encuentra la ruta.
FERRY

string

Secciones de la ruta que son ferries.
MOTORWAY

string

Tramos de la ruta que son autopistas.
PEDESTRIAN

string

Secciones de la ruta que solo son adecuadas para los peatonales.
TOLL_ROAD

string

Secciones de la ruta que requieren que se pague un peaje.
TOLL_VIGNETTE

string

Secciones de la ruta que requieren que haya una viñeta de peaje.
TRAFFIC

string

Secciones de la ruta que contienen información de tráfico.
TRAVEL_MODE

string

Secciones en relación con el parámetro travelModede solicitud .
TUNNEL

string

Secciones de la ruta que son túneles.
URBAN

string

Secciones de la ruta que se encuentran dentro de las zonas urbanas.

ResponseTravelMode

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

Nombre Tipo Description
bicycle

string

Las rutas devueltas están optimizadas para bicicletas, incluido el uso de carriles para bicicletas.
bus

string

Las rutas devueltas están optimizadas para los autobuses, incluido el uso de solo carriles de autobús. Funcionalidad BETA.
car

string

Las rutas devueltas están optimizadas para automóviles.
motorcycle

string

Las rutas devueltas están optimizadas para motocicletas. Funcionalidad BETA.
other

string

El modo de transporte dado no es posible en esta sección
pedestrian

string

Las rutas devueltas están optimizadas para los peatonales, 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 camionetas. Funcionalidad BETA.

Route

Nombre Tipo Description
guidance

RouteGuidance

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

RouteLeg[]

Matriz de piernas
sections

RouteSection[]

Matriz de secciones
summary

RouteSummary

Summary (objeto)

RouteDirectionsBatchItem

Un elemento devuelto por la llamada al servicio Route Directions Batch.

Nombre Tipo Description
response

Response

Resultado de la consulta. RouteDirections si la consulta se completó correctamente, ErrorResponse de lo contrario.
statusCode

integer

Código de estado de la solicitud HTTP.

RouteDirectionsBatchResult

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

Nombre Tipo Description
batchItems

RouteDirectionsBatchItem[]

Matriz que contiene los resultados del lote.
summary

Summary

Resumen de los resultados de la solicitud por lotes

RouteGuidance

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

Nombre Tipo Description
instructionGroups

RouteInstructionGroup[]

Grupos una secuencia de elementos de instrucción relacionados entre sí.
instructions

RouteInstruction[]

Una lista de instrucciones que describen maniobras.

RouteInstruction

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

Nombre Tipo Description
combinedMessage

string

Un mensaje legible para la maniobra combinada con el mensaje de la siguiente instrucción. A veces es posible combinar dos instrucciones sucesivas en una sola instrucción, lo que facilita el seguimiento. Cuando este es el caso, la marca possibleCombineWithNext será true. Por ejemplo:

10. Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam
11. Follow Einsteinweg/A10/E22 towards Ring Amsterdam

La marca possibleCombineWithNext en la instrucción 10 es true. Esto indica a los clientes de instrucciones codificadas que se pueden combinar con la instrucción 11. Las instrucciones se combinarán automáticamente para los clientes que solicitan instrucciones legibles. El campo combinedMessage contiene el mensaje combinado:

Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam
then follow Einsteinweg/A10/E22 towards Ring Amsterdam.
countryCode

string

Código de país ISO 3166-1 alfa-3 de 3 caracteres. Por ejemplo, Estados Unidos.
drivingSide

DrivingSide

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

string

El número de una salida de carretera tomada por la maniobra actual. Si una salida tiene varios números de salida, se separarán por "," y posiblemente se agregarán por "-", por ejemplo, "10, 13-15".
instructionType

GuidanceInstructionType

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

JunctionType

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

GuidanceManeuver

Código que identifica la maniobra.
message

string

Un mensaje legible para la maniobra.
point

LatLongPair

Una ubicación representada como latitud y longitud.
pointIndex

integer

Índice del punto de la lista de "puntos" de polilínea correspondiente al punto de la instrucción.
possibleCombineWithNext

boolean

Opcionalmente, es posible combinar la instrucción con la siguiente. Esto se puede usar para crear mensajes como "Girar a la izquierda y, a continuación, girar a la derecha".
roadNumbers

string[]

Los números de carretera de los siguientes segmentos de carretera significativos después de la maniobra, o de las carreteras que se van a seguir. Ejemplo: ["E34", "N205"]
roundaboutExitNumber

string

Esto indica qué salida tomar en una rotonda.
routeOffsetInMeters

integer

Distancia desde el inicio de la ruta hasta el punto de la instrucción.
signpostText

string

Texto sobre una señal que es más relevante para la maniobra, o hacia la dirección que se debe seguir.
stateCode

string

Subdivisión (por ejemplo, estado) del país, representada por la segunda parte de un código ISO 3166-2 . Esto solo está disponible para algunos países o regiones, como Estados Unidos, Canadá y México.
street

string

Nombre de la calle del siguiente segmento significativo de carretera después de la maniobra, o de la calle que debe seguirse.
travelTimeInSeconds

integer

Tiempo de viaje estimado hasta el punto correspondiente a routeOffsetInMeters.
turnAngleInDecimalDegrees

integer

Indica la dirección de una instrucción. Si junctionType indica una instrucción de turno:

  • 180 = U-turn
  • [-179, -1] = Giro a la izquierda
  • 0 = Recto en (un giro de '0 grados')
  • [1, 179] = Giro a la derecha

Si junctionType indica una instrucción de bifurcación:

  • <0 - mantener a la izquierda
  • >0 - mantener la derecha

RouteInstructionGroup

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

Nombre Tipo Description
firstInstructionIndex

integer

Índice de la primera instrucción de las instrucciones y pertenencia a este grupo.
groupLengthInMeters

integer

Longitud del grupo.
groupMessage

string

Mensaje de resumen cuando se solicitan mensajes de texto legibles para personas para obtener instrucciones (instructionType=text o etiquetados).
lastInstructionIndex

integer

Índice de la última instrucción de las instrucciones y pertenencia a este grupo.

RouteLeg

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

Nombre Tipo Description
points

LatLongPair[]

Matriz de puntos
summary

RouteLegSummary

Objeto de resumen para la sección de ruta.

RouteLegSummary

Objeto de resumen para la sección de ruta.

Nombre Tipo Description
arrivalTime

string

Hora estimada de llegada para la ruta o pierna. La hora es UTC.
batteryConsumptionInkWh

number

Consumo estimado de energía eléctrica en kilowatt horas (kWh) utilizando el modelo de consumo eléctrico. Se incluye si vehicleEngineType se establece en eléctrico y se especifica constantSpeedConsumptionInkWhPerHundredkm. 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, la recuperación se limitará 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 es UTC.
fuelConsumptionInLiters

number

Consumo estimado de combustible en litros utilizando el modelo de consumo de combustión. Se incluye si vehicleEngineType se establece en combustión y se especifica constantSpeedConsumptionInLitersPerHundredkm. El valor no será negativo.
historicTrafficTravelTimeInSeconds

integer

Tiempo de desplazamiento estimado calculado mediante datos de tráfico histórico dependientes del tiempo. Solo se incluye si compute TravelTimeFor = se usa en la consulta.
lengthInMeters

integer

Length In Meters (propiedad)
liveTrafficIncidentsTravelTimeInSeconds

integer

Tiempo de desplazamiento estimado calculado mediante datos de velocidad en tiempo real. Solo se incluye si compute TravelTimeFor = se usa en la consulta.
noTrafficTravelTimeInSeconds

integer

Tiempo estimado de viaje calculado como si no hubiera retrasos en la ruta debido a condiciones de tráfico (por ejemplo, congestión). Solo se incluye si compute TravelTimeFor = se usa en la consulta.
trafficDelayInSeconds

integer

Retraso estimado en segundos causado por los incidentes en tiempo real según la información de tráfico. En el caso de las rutas planeadas con la hora de salida en el futuro, los retrasos siempre son 0. Para devolver tiempos de desplazamiento adicionales con diferentes tipos de información de tráfico, es necesario agregar el parámetro compute TravelTimeFor=all.
travelTimeInSeconds

integer

Tiempo de viaje estimado en segundos propiedad que incluye el retraso debido al tráfico en tiempo real. Tenga en cuenta que incluso cuando traffic=false travelTimeInSeconds todavía incluye el retraso debido al tráfico. Si DepartAt está en el futuro, el tiempo de viaje se calcula mediante datos de tráfico histórico dependientes del tiempo.

RouteOptimizedWaypoint

Objeto de punto de forma optimizado.

Nombre Tipo Description
optimizedIndex

integer

Índice de punto de la forma optimizado desde el sistema.
providedIndex

integer

Índice de punto de la forma proporcionado por el usuario.

RouteReport

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

Nombre Tipo Description
effectiveSettings

EffectiveSetting[]

Parámetros o datos efectivos que se usan al llamar a esta ROUTE API.

RouteSection

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

Nombre Tipo Description
delayInSeconds

integer

Retraso en segundos causado por el incidente.
effectiveSpeedInKmh

integer

Velocidad efectiva del incidente en km/h, promediada en toda su longitud.
endPointIndex

integer

Índice del último punto (desplazamiento 0) de la ruta a la que se aplica esta sección.
magnitudeOfDelay

DelayMagnitude

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

ResponseSectionType

Tipos de sección de la respuesta de ruta notificada
simpleCategory

SimpleCategory

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

integer

Índice del primer punto (desplazamiento 0) de la ruta a la que se aplica esta sección.
tec

RouteSectionTec

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

ResponseTravelMode

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

RouteSectionTec

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

Nombre Tipo Description
causes

RouteSectionTecCause[]

Causas de la matriz
effectCode

integer

Efecto en el flujo de tráfico. Contiene un valor en la tabla tec001:EffectCode, tal como se define en el estándar TPEG2-TEC . Se puede usar para codificar los eventos de tráfico según la gravedad.

RouteSectionTecCause

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

Nombre Tipo Description
mainCauseCode

integer

La causa principal del evento de tráfico. Contiene un valor en la tabla tec002:CauseCode, tal como se define en el estándar TPEG2-TEC .
subCauseCode

integer

Subcadena del evento de tráfico. Contiene un valor en la tabla de causas secundarias definida por mainCauseCode, tal como se define en el estándar TPEG2-TEC .

RouteSummary

Summary (objeto)

Nombre Tipo Description
arrivalTime

string

Hora estimada de llegada para la ruta o pierna. La hora es UTC.
departureTime

string

Hora estimada de salida para la ruta o la pierna. La hora es UTC.
lengthInMeters

integer

Length In Meters (propiedad)
trafficDelayInSeconds

integer

Retraso estimado en segundos causado por los incidentes en tiempo real según la información de tráfico. En el caso de las rutas planeadas con la hora de salida en el futuro, los retrasos siempre son 0. Para devolver tiempos de desplazamiento adicionales con diferentes tipos de información de tráfico, es necesario agregar el parámetro compute TravelTimeFor=all.
travelTimeInSeconds

integer

Tiempo de viaje estimado en segundos propiedad que incluye el retraso debido al tráfico en tiempo real. Tenga en cuenta que incluso cuando traffic=false travelTimeInSeconds todavía incluye el retraso debido al tráfico. Si DepartAt está en el futuro, el tiempo de viaje se calcula mediante datos de tráfico histórico dependientes del tiempo.

SimpleCategory

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

Nombre Tipo Description
JAM

string

Atasco.
OTHER

string

Otros.
ROAD_CLOSURE

string

Cierre de carretera.
ROAD_WORK

string

Trabajo de carretera.

Summary

Resumen de los resultados 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