Compartir a través de


Route - Post Route Directions

Utilice para obtener la mejor ruta entre un origen y destino para automóviles, camiones comerciales y rutas a pie.

La API de Route Directions es una solicitud HTTP POST que devuelve la ruta ideal entre un origen y un destino para automóviles (conducción), camiones comerciales y rutas a pie. La ruta pasa a través de una serie de puntos de referencia si se especifica. Un punto de acceso es una ubicación geográfica definida por longitud y latitud que se usa con fines de navegación. La ruta tiene en cuenta factores como el tráfico actual y las velocidades típicas de la carretera en el día solicitado de la semana y la hora del día.

La API devuelve la distancia, el tiempo de desplazamiento estimado y una representación de la geometría de ruta. También hay disponible más información de enrutamiento, como un orden de punto de acceso optimizado o las instrucciones de turno por turno, en función de los parámetros usados.

Route Directions considera leyes locales, dimensiones de vehículo, tipo de carga, velocidad máxima, alturas de puente y túnel para calcular las rutas específicas del camión y evitar maniobras complejas y carreteras difíciles. No todos los camiones pueden viajar por las mismas rutas que otros vehículos debido a ciertas restricciones basadas en el perfil de vehículo o el tipo de carga. Por ejemplo, las autopistas suelen tener límites de velocidad separados para camiones, algunas carreteras no permiten camiones con materiales inflamables o peligrosos, y puede haber restricciones de altura y peso en puentes.

Se admiten hasta 25 puntos de acceso y 10 viaWaypoints entre dos puntos de camino para conducir y caminar rutas. Cada conjunto de puntos de referencia crea un tramo de ruta independiente. ViaWaypoints define la ruta de acceso de ruta y se puede usar para la creación de rutas a través de ubicaciones específicas, pero no crean rutas legs. Las rutas de camión admiten hasta 150 puntos de acceso, pero no admiten viaWaypoints.

Para obtener información sobre la disponibilidad de enrutamiento en países o regiones, consulte cobertura de enrutamiento de Azure Maps.

POST https://atlas.microsoft.com/route/directions?api-version=2025-01-01

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

Media Types: "application/geo+json"

Nombre Requerido Tipo Description
x-ms-client-id

string

Especifica qué cuenta está pensada para su uso junto con el modelo de seguridad de Id. de Microsoft Entra. Representa un identificador único para la cuenta de Azure Maps y se puede recuperar de la API de cuenta del plano de administración de Azure Maps. To use Microsoft Entra ID security in Azure Maps see the following articles for guidance.

Accept-Language

string

Idioma en el que se deben devolver los resultados de enrutamiento.

Para más información, consulte compatibilidad con la localización de en Azure Maps.

Cuerpo de la solicitud

Media Types: "application/geo+json"

Nombre Requerido Tipo Description
features True

InputWaypointFeaturesItem[]

Las rutas de conducción y caminata se definen mediante un conjunto de puntos de acceso (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 referencia. La ruta de camión admite hasta 150 puntos de acceso y viaWaypoints no se admite.

Una ruta debe tener un mínimo de 2 puntos de acceso 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 GeoJSON Point válido junto con pointIndex que especifica el orden de las ubicaciones. For more information on the GeoJSON format, see RFC 7946.

type True

FeatureTypeEnum

Especifica el tipo de GeoJSON. El único tipo de objeto admitido es FeatureCollection. For more information, see RFC 7946.

arriveAt

string (date-time)

Fecha y hora de llegada al punto de destino con formato de dateTime valor definido por RFC 3339, sección 5.6. Cuando no se especifica un desplazamiento de zona horaria, se asume la hora UTC.

No se puede usar el parámetro arriveAt junto con departAt.

Ejemplo: "arriveAt": "2023-06-01T09:30:00.000-07:00"

avoid

AvoidEnum[]

Especifica las restricciones que debe respetar el cálculo de la ruta 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", "tollRoads"]

departAt

string (date-time)

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 asume la hora UTC.

Si no se establece el departAt, el valor predeterminado es la hora actual.

Example:

"departAt": "2023-06-01T09:30:00.000-07:00"

heading

integer (int64)

minimum: 0
maximum: 359

El encabezado direccional inicial del vehículo en grados a partir del verdadero Norte y continuando en dirección a las agujas del reloj. El norte es de 0 grados, el este es de 90 grados, el sur es de 180 grados, el oeste es de 270 grados.

maxRouteCount

integer (int64)

minimum: 1
maximum: 6

Número máximo de rutas que se van a devolver. Disponible para los modos de conducción y transporte de camión.

Default: "maxRouteCount":1

optimizeRoute

RouteDirectionOptimizeRouteEnum

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.

Example: "optimizeRoute":"shortest"

optimizeWaypointOrder

boolean

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.

routeOutputOptions

RouteOutputOptionEnum[]

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", "itinerary"]

travelMode

TravelModeEnum

Modo de desplazamiento 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".

Example: "travelMode":"driving"

vehicleSpec

RouteDirectionVehicleSpec

Especifica los atributos del vehículo, como el tamaño, el peso, la velocidad máxima, el tipo de carga, etc. solo para el enrutamiento de camiones. Esto ayuda a evitar bajas distancias de puente, restricciones de carretera, giros difíciles a la derecha para proporcionar la ruta optimizada del camión en función de las especificaciones del vehículo.

Note: solo se admite para truck travelMode

Respuestas

Nombre Tipo Description
200 OK

RouteDirectionsResponse

OK

Media Types: "application/geo+json", "application/json"

Other Status Codes

MapsErrorResponse

Se ha producido un error inesperado.

Media Types: "application/geo+json", "application/json"

Encabezados

x-ms-error-code: string

Seguridad

AADToken

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

To implement scenarios, we recommend viewing authentication concepts. En resumen, esta definición de seguridad proporciona una solución para modelar aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.

Note

  • This security definition requires the use of the x-ms-client-id header to indicate which Azure Maps resource the application is requesting access to. Esto se puede adquirir desde la API de administración de Maps.
  • El Authorization URL es específico de la instancia de nube pública de Azure. Las nubes soberanas tienen direcciones URL de autorización únicas y configuraciones de id. de Microsoft Entra.
  • El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure a través de Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST.
  • El uso de SDK web de Azure Maps permite la configuración basada en la configuración de una aplicación para varios casos de uso.
  • Para obtener más información sobre la plataforma de identidad de Microsoft, consulte introducción a la plataforma de identidad de Microsoft.

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

Ámbitos

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

subscription-key

Se trata de una clave compartida que se aprovisiona al crear una 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 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 las API REST de Azure Maps donde esta clave se puede almacenar de forma segura.

Tipo: apiKey
En: header

SAS Token

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

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

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

Tipo: apiKey
En: header

Ejemplos

Successfully retrieve a route between an origin and a destination with additional parameters in the body

Solicitud de ejemplo

POST https://atlas.microsoft.com/route/directions?api-version=2025-01-01

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "coordinates": [
          -122.201399,
          47.608678
        ],
        "type": "Point"
      },
      "properties": {
        "pointIndex": 0,
        "pointType": "waypoint"
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "coordinates": [
          -122.20687,
          47.612002
        ],
        "type": "Point"
      },
      "properties": {
        "pointIndex": 1,
        "pointType": "viaWaypoint"
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "coordinates": [
          -122.201669,
          47.615076
        ],
        "type": "Point"
      },
      "properties": {
        "pointIndex": 2,
        "pointType": "waypoint"
      }
    }
  ],
  "optimizeRoute": "fastestWithTraffic",
  "routeOutputOptions": [
    "routePath"
  ],
  "maxRouteCount": 3,
  "travelMode": "driving"
}

Respuesta de muestra

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.20147,
          47.60868
        ]
      },
      "properties": {
        "routePathPoint": {
          "legIndex": 0,
          "pointIndex": 0
        },
        "order": {
          "inputIndex": 0
        },
        "type": "Waypoint"
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.2016,
          47.61508
        ]
      },
      "properties": {
        "routePathPoint": {
          "legIndex": 0,
          "pointIndex": 64
        },
        "order": {
          "inputIndex": 2
        },
        "type": "Waypoint"
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "MultiLineString",
        "coordinates": [
          [
            [
              -122.20147,
              47.60868
            ],
            [
              -122.20148,
              47.60884
            ],
            [
              -122.20148,
              47.60906
            ],
            [
              -122.20148,
              47.60919
            ],
            [
              -122.20148,
              47.60953
            ],
            [
              -122.20148,
              47.60967
            ],
            [
              -122.20149,
              47.60997
            ],
            [
              -122.2015,
              47.61011
            ],
            [
              -122.2015,
              47.61019
            ],
            [
              -122.20192,
              47.61021
            ],
            [
              -122.20199,
              47.61021
            ],
            [
              -122.20252,
              47.61019
            ],
            [
              -122.20264,
              47.61018
            ],
            [
              -122.20271,
              47.61015
            ],
            [
              -122.20276,
              47.61015
            ],
            [
              -122.20281,
              47.61015
            ],
            [
              -122.20286,
              47.61015
            ],
            [
              -122.20329,
              47.61016
            ],
            [
              -122.20346,
              47.61016
            ],
            [
              -122.20414,
              47.61017
            ],
            [
              -122.20416,
              47.61057
            ],
            [
              -122.20418,
              47.61083
            ],
            [
              -122.20418,
              47.61092
            ],
            [
              -122.20419,
              47.61103
            ],
            [
              -122.20419,
              47.61121
            ],
            [
              -122.2042,
              47.61126
            ],
            [
              -122.20478,
              47.61127
            ],
            [
              -122.20555,
              47.61128
            ],
            [
              -122.20569,
              47.61128
            ],
            [
              -122.20596,
              47.61128
            ],
            [
              -122.20617,
              47.61127
            ],
            [
              -122.20624,
              47.61125
            ],
            [
              -122.2066,
              47.61126
            ],
            [
              -122.20669,
              47.61127
            ],
            [
              -122.20686,
              47.61129
            ],
            [
              -122.20687,
              47.61158
            ],
            [
              -122.20689,
              47.61187
            ],
            [
              -122.20691,
              47.61233
            ],
            [
              -122.20691,
              47.61247
            ],
            [
              -122.20694,
              47.61317
            ],
            [
              -122.20695,
              47.61342
            ],
            [
              -122.20696,
              47.61362
            ],
            [
              -122.20697,
              47.61384
            ],
            [
              -122.20683,
              47.61384
            ],
            [
              -122.20638,
              47.61384
            ],
            [
              -122.20612,
              47.61384
            ],
            [
              -122.20568,
              47.61383
            ],
            [
              -122.20559,
              47.6138
            ],
            [
              -122.20467,
              47.61379
            ],
            [
              -122.20443,
              47.61379
            ],
            [
              -122.20405,
              47.61379
            ],
            [
              -122.20325,
              47.6138
            ],
            [
              -122.203,
              47.6138
            ],
            [
              -122.20274,
              47.6138
            ],
            [
              -122.20241,
              47.61381
            ],
            [
              -122.20222,
              47.6138
            ],
            [
              -122.20202,
              47.6138
            ],
            [
              -122.20193,
              47.6138
            ],
            [
              -122.20181,
              47.61386
            ],
            [
              -122.20167,
              47.61386
            ],
            [
              -122.20155,
              47.61386
            ],
            [
              -122.20158,
              47.61464
            ],
            [
              -122.20159,
              47.61475
            ],
            [
              -122.2016,
              47.61503
            ],
            [
              -122.2016,
              47.61508
            ]
          ]
        ]
      },
      "properties": {
        "distanceInMeters": 1520,
        "durationInSeconds": 307,
        "departureAt": "2025-06-17T09:08:10+00:00",
        "arrivalAt": "2025-06-17T09:13:10+00:00",
        "durationTrafficInSeconds": 300,
        "trafficCongestion": "Medium",
        "type": "RoutePath",
        "legs": [
          {
            "distanceInMeters": 1520,
            "durationInSeconds": 307,
            "durationTrafficInSeconds": 300,
            "departureAt": "2025-06-17T09:08:10+00:00",
            "arrivalAt": "2025-06-17T09:13:10+00:00",
            "routePathRange": {
              "legIndex": 0,
              "range": [
                0,
                64
              ]
            }
          }
        ]
      },
      "bbox": [
        -122.20697,
        47.60868,
        -122.20147,
        47.61508
      ]
    }
  ],
  "alternativeRoutes": [
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "type": "Point",
            "coordinates": [
              -122.20147,
              47.60868
            ]
          },
          "properties": {
            "routePathPoint": {
              "legIndex": 0,
              "pointIndex": 0
            },
            "order": {
              "inputIndex": 0
            },
            "type": "Waypoint"
          }
        },
        {
          "type": "Feature",
          "geometry": {
            "type": "Point",
            "coordinates": [
              -122.2016,
              47.61508
            ]
          },
          "properties": {
            "routePathPoint": {
              "legIndex": 0,
              "pointIndex": 29
            },
            "order": {
              "inputIndex": 1
            },
            "type": "Waypoint"
          }
        },
        {
          "type": "Feature",
          "geometry": {
            "type": "MultiLineString",
            "coordinates": [
              [
                [
                  -122.20147,
                  47.60868
                ],
                [
                  -122.20148,
                  47.60884
                ],
                [
                  -122.20148,
                  47.60906
                ],
                [
                  -122.20148,
                  47.60919
                ],
                [
                  -122.20148,
                  47.60953
                ],
                [
                  -122.20148,
                  47.60967
                ],
                [
                  -122.20149,
                  47.60997
                ],
                [
                  -122.2015,
                  47.61011
                ],
                [
                  -122.2015,
                  47.61019
                ],
                [
                  -122.20151,
                  47.61072
                ],
                [
                  -122.20152,
                  47.61092
                ],
                [
                  -122.20152,
                  47.61097
                ],
                [
                  -122.20149,
                  47.611
                ],
                [
                  -122.20147,
                  47.61104
                ],
                [
                  -122.20145,
                  47.61117
                ],
                [
                  -122.20145,
                  47.61122
                ],
                [
                  -122.20145,
                  47.61126
                ],
                [
                  -122.20146,
                  47.61149
                ],
                [
                  -122.20147,
                  47.61166
                ],
                [
                  -122.20148,
                  47.61197
                ],
                [
                  -122.20148,
                  47.61203
                ],
                [
                  -122.2015,
                  47.61268
                ],
                [
                  -122.20151,
                  47.61289
                ],
                [
                  -122.20152,
                  47.61297
                ],
                [
                  -122.20153,
                  47.61338
                ],
                [
                  -122.20155,
                  47.61386
                ],
                [
                  -122.20158,
                  47.61464
                ],
                [
                  -122.20159,
                  47.61475
                ],
                [
                  -122.2016,
                  47.61503
                ],
                [
                  -122.2016,
                  47.61508
                ]
              ]
            ]
          },
          "properties": {
            "distanceInMeters": 713,
            "durationInSeconds": 92,
            "departureAt": "2025-06-17T09:08:10+00:00",
            "arrivalAt": "2025-06-17T09:09:40+00:00",
            "durationTrafficInSeconds": 90,
            "trafficCongestion": "Medium",
            "type": "RoutePath",
            "legs": [
              {
                "distanceInMeters": 713,
                "durationInSeconds": 92,
                "durationTrafficInSeconds": 90,
                "departureAt": "2025-06-17T09:08:10+00:00",
                "arrivalAt": "2025-06-17T09:09:40+00:00",
                "routePathRange": {
                  "legIndex": 0,
                  "range": [
                    0,
                    29
                  ]
                }
              }
            ]
          },
          "bbox": [
            -122.2016,
            47.60868,
            -122.20145,
            47.61508
          ]
        }
      ]
    }
  ]
}

Definiciones

Nombre Description
Address

El distrito administrativo y la región del país para los puntos de referencia y los puntos de maniobra en la ruta.

AdminDistrict

Nombre de subdivisión en el país o región de una dirección. Este elemento normalmente se trata 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.

AdrTunnelRestrictionCodeEnum

Código de restricción del túnel ADR. ADR es un acuerdo europeo relativo al transporte internacional de mercancías peligrosas por carretera. El código de restricción del túnel ADR se utiliza para determinar si se permite que un vehículo pase a través de un túnel con restricciones sobre el transporte de mercancías peligrosas.

AvoidEnum

Especifica las restricciones que debe respetar el cálculo de la ruta 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", "tollRoads"]

CountryRegion

Representa un país o región que contiene detalles relacionados.

DirectionsRequest

Este objeto es el cuerpo de la solicitud.

DrivingSideEnum

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

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 de GeoJSON. El único tipo de objeto admitido es Feature. For more information, see RFC 7946.

FeatureTypeEnum

Especifica el tipo de GeoJSON. El único tipo de objeto admitido es FeatureCollection. For more information, see RFC 7946.

GeoJsonPoint

Un tipo de geometría GeoJSON Point válido. Please refer to RFC 7946 for details.

InputWaypointFeaturesItem

Especifica el punto de acceso de entrada y viaWaypoint GeoJSON objeto de característica y propiedades adicionales. For more information, see RFC 7946.

InputWaypointProperties

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

InputWaypointTypeEnum

Tipo de punto de acceso 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 un tramo de ruta:

ManeuverPointProperties

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

ManeuverTypeEnum

Tipo de maniobra descrito en esta colección detallada. El Tipo de maniobra proporciona información para una parte de la maniobra especificada por la instrucción correspondiente. Por ejemplo, el tipo de maniobra de una instrucción puede especificar TurnLeftThenTurnRight, mientras que los elementos de detalle asociados pueden proporcionar 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. For more information, see RFC 7946.

OptimizedWaypoint

Objeto de punto de forma optimizado.

Order

Secuencia para visitar waypoints.

PointGeometry

El punto de origen pasado como un objeto Geometry válido GeoJSON, desde el que se debe calcular el polígono de intervalo. Please refer to RFC 7946 for details.

Note: la API ajustará el punto de origen solicitado a la red de carreteras más cercana y la usará para el cálculo del intervalo. Se devolverá como punto de center en la respuesta.

RouteDirectionOptimizeRouteEnum

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.

Example: "optimizeRoute":"shortest"

RouteDirectionsResponse

Este objeto se devuelve de una llamada correcta.

RouteDirectionVehicleSpec

Especifica los atributos del vehículo, como el tamaño, el peso, la velocidad máxima, el tipo de carga, etc. solo para el enrutamiento de camiones. Esto ayuda a evitar bajas distancias de puente, restricciones de carretera, giros difíciles a la derecha para proporcionar la ruta optimizada del camión en función de las especificaciones del vehículo.

ISNote: solo se admite para truck travelMode.

RouteOutputOptionEnum

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", "itinerary"]

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.

RoutePathTravelModeEnum

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 de turno a paso. Un paso hace referencia a un intervalo de una ruta entre dos maniobras consecutivas.

TrafficCongestionEnum

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

TravelModeEnum

Modo de desplazamiento 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".

Example: "travelMode":"driving"

VehicleLoadTypeEnum

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

WaypointProperties

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

Address

El distrito administrativo y la región del país para los puntos de referencia y los puntos de maniobra en la ruta.

Nombre Tipo Description
adminDistricts

AdminDistrict[]

Nombre de subdivisión en el país o región de una dirección. Este elemento normalmente se trata 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.

countryRegion

CountryRegion

Representa un país o región que contiene detalles relacionados.

AdminDistrict

Nombre de subdivisión en el país o región de una dirección. Este elemento normalmente se trata 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
shortName

string

Nombre corto del campo adminDistrict correspondiente, Para adminDistrict[0], podría ser un nombre corto de estado, como WA. Esto solo está disponible para estados Unidos, Canadá y México.

AdrTunnelRestrictionCodeEnum

Código de restricción del túnel ADR. ADR es un acuerdo europeo relativo al transporte internacional de mercancías peligrosas por carretera. El código de restricción del túnel ADR se utiliza para determinar si se permite que un vehículo pase a través de un túnel con restricciones sobre el transporte de mercancías peligrosas.

Valor Description
B

Los vehículos con código B están restringidos de carreteras con categorías de túnel ADR B, C, D y E.

C

Los vehículos con código C están restringidos de carreteras con categorías de túnel ADR C, D y E

D

Los vehículos con código D están restringidos a las carreteras con categorías de túnel ADR D y E.

E

Los vehículos con código E están restringidos a las carreteras con la categoría de túnel ADR E.

AvoidEnum

Especifica las restricciones que debe respetar el cálculo de la ruta 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", "tollRoads"]

Valor Description
limitedAccessHighways

Evita el uso de autopistas de acceso limitado en la ruta.

tollRoads

Evita el uso de carreteras de peaje en la ruta.

ferries

Evita el uso de ferris en la ruta.

tunnels

Evita el uso de túneles en la ruta.

borderCrossings

Evita cruzar las fronteras del país en la ruta.

lowEmissionZones

Evita zonas de baja emisión en la ruta.

unpavedRoads

Evita carreteras sin pintar en la ruta.

CountryRegion

Representa un país o región que contiene detalles relacionados.

Nombre Tipo Description
ISO

string

ISO de país o región representa un código de país o país ISO 3166-1 Alpha-2

name

string

nombre del país o región

DirectionsRequest

Este objeto es el cuerpo de la solicitud.

Nombre Tipo Valor predeterminado Description
arriveAt

string (date-time)

Fecha y hora de llegada al punto de destino con formato de dateTime valor definido por RFC 3339, sección 5.6. Cuando no se especifica un desplazamiento de zona horaria, se asume la hora UTC.

No se puede usar el parámetro arriveAt junto con departAt.

Ejemplo: "arriveAt": "2023-06-01T09:30:00.000-07:00"

avoid

AvoidEnum[]

Especifica las restricciones que debe respetar el cálculo de la ruta 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", "tollRoads"]

departAt

string (date-time)

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 asume la hora UTC.

Si no se establece el departAt, el valor predeterminado es la hora actual.

Example:

"departAt": "2023-06-01T09:30:00.000-07:00"

features

InputWaypointFeaturesItem[]

Las rutas de conducción y caminata se definen mediante un conjunto de puntos de acceso (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 referencia. La ruta de camión admite hasta 150 puntos de acceso y viaWaypoints no se admite.

Una ruta debe tener un mínimo de 2 puntos de acceso 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 GeoJSON Point válido junto con pointIndex que especifica el orden de las ubicaciones. For more information on the GeoJSON format, see RFC 7946.

heading

integer (int64)

minimum: 0
maximum: 359

El encabezado direccional inicial del vehículo en grados a partir del verdadero Norte y continuando en dirección a las agujas del reloj. El norte es de 0 grados, el este es de 90 grados, el sur es de 180 grados, el oeste es de 270 grados.

maxRouteCount

integer (int64)

minimum: 1
maximum: 6

Número máximo de rutas que se van a devolver. Disponible para los modos de conducción y transporte de camión.

Default: "maxRouteCount":1

optimizeRoute

RouteDirectionOptimizeRouteEnum

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.

Example: "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.

routeOutputOptions

RouteOutputOptionEnum[]

[ "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", "itinerary"]

travelMode

TravelModeEnum

driving

Modo de desplazamiento 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".

Example: "travelMode":"driving"

type

FeatureTypeEnum

Especifica el tipo de GeoJSON. El único tipo de objeto admitido es FeatureCollection. For more information, see RFC 7946.

vehicleSpec

RouteDirectionVehicleSpec

Especifica los atributos del vehículo, como el tamaño, el peso, la velocidad máxima, el tipo de carga, etc. solo para el enrutamiento de camiones. Esto ayuda a evitar bajas distancias de puente, restricciones de carretera, giros difíciles a la derecha para proporcionar la ruta optimizada del camión en función de las especificaciones del vehículo.

Note: solo se admite para truck travelMode

DrivingSideEnum

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

Valor Description
Left

Conducción a la izquierda.

Right

Conducción a la derecha.

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 de característica que contiene el objeto Geometry y propiedades adicionales. Para obtener más información, vea RFC 7946, Sección 3.2.

type

FeatureTypeEnum

Especifica el tipo de GeoJSON. El único tipo de objeto admitido es FeatureCollection. For more information, see RFC 7946.

FeaturesItem

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

Nombre Tipo Description
bbox

number[] (double)

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 RouteDirectionsGeometry:

Objeto Geometry válido GeoJSON. For more information, see RFC 7946.

properties FeatureProperties:

Especifica las propiedades de características de la ruta, como el itinerario, las piernas de ruta y la geometría, el resumen de viaje.

type

FeaturesItemTypeEnum

Especifica el tipo de GeoJSON. El único tipo de objeto admitido es Feature. For more information, see RFC 7946.

FeaturesItemTypeEnum

Especifica el tipo de GeoJSON. El único tipo de objeto admitido es Feature. For more information, see RFC 7946.

Valor Description
Feature

Especifica el tipo de objeto feature de GeoJSON.

FeatureTypeEnum

Especifica el tipo de GeoJSON. El único tipo de objeto admitido es FeatureCollection. For more information, see RFC 7946.

Valor Description
FeatureCollection

Especifica el tipo de objeto GeoJSONFeatureCollection.

GeoJsonPoint

Un tipo de geometría GeoJSON Point válido. Please refer to RFC 7946 for details.

Nombre Tipo Description
coordinates

number[] (double)

Un Position es una matriz de números con dos o más elementos. The first two elements are longitude and latitude, precisely in that order. Altitude/Elevation is an optional third element. Please refer to RFC 7946 for details.

type string:

Point

Especifica el tipo de GeoJSON. Debe ser uno de los nueve tipos de objeto GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

InputWaypointFeaturesItem

Especifica el punto de acceso de entrada y viaWaypoint GeoJSON objeto de característica y propiedades adicionales. For more information, see RFC 7946.

Nombre Tipo Description
geometry GeoJsonPoint:

PointGeometry

Un tipo de geometría GeoJSON Point válido. Please refer to RFC 7946 for details.

properties

InputWaypointProperties

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

type

FeaturesItemTypeEnum

Especifica el tipo de GeoJSON. El único tipo de objeto admitido es Feature. For more information, see RFC 7946.

InputWaypointProperties

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

Nombre Tipo Valor predeterminado Description
pointIndex

integer (int64)

Identifique y ordene la secuencia de puntos de referencia en la ruta. El valor predeterminado es el index value de una matriz de características.

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.

InputWaypointTypeEnum

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

Valor Description
waypoint

Un punto de referencia es una ubicación o punto específico a lo largo de una ruta o viaje que actúa como referencia o punto de detención.

viaWaypoint

Un viaWaypoint es un punto de acceso específico que debe pasarse o visitarse a lo largo de una ruta o viaje.

Instruction

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

Nombre Tipo Description
drivingSide

DrivingSideEnum

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

formattedText

string

Descripción del texto con formato de la instrucción.

maneuverType

ManeuverTypeEnum

Tipo de maniobra descrito en esta colección detallada. El Tipo de maniobra proporciona información para una parte de la maniobra especificada por la instrucción correspondiente. Por ejemplo, el tipo de maniobra de una instrucción puede especificar TurnLeftThenTurnRight, mientras que los elementos de detalle asociados pueden proporcionar 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 un tramo de ruta:

Nombre Tipo Description
arrivalAt

string (date-time)

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 mediante departAt o arrivalAt. Si no es así, se usará la hora UTC.

departureAt

string (date-time)

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 mediante departAt o arrivalAt. Si no es así, se usará la hora UTC.

distanceInMeters

number

Distancia física en metros cubiertos por una pierna de ruta.

durationInSeconds

integer (int64)

Tiempo estimado de viaje en segundos que no incluye retrasos en la ruta debido a las condiciones de tráfico.

durationTrafficInSeconds

integer (int64)

El tiempo que tarda, en segundos, en viajar un TravelDistance correspondiente 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.

ManeuverPointProperties

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

Nombre Tipo Valor predeterminado Description
address

Address

El distrito administrativo y la región del país para los puntos de referencia y los puntos de maniobra en la ruta.

distanceInMeters

number

Distancia física en metros cubiertos por este paso de ruta.

durationInSeconds

integer (int64)

El tiempo que tarda, en segundos, en viajar un TravelDistancecorrespondiente.

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

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

RoutePathTravelModeEnum

driving

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

type string:

ManeuverPoint

Output type.

ManeuverTypeEnum

Tipo de maniobra descrito en esta colección detallada. El Tipo de maniobra proporciona información para una parte de la maniobra especificada por la instrucción correspondiente. Por ejemplo, el tipo de maniobra de una instrucción puede especificar TurnLeftThenTurnRight, mientras que los elementos de detalle asociados pueden proporcionar detalles sobre las maniobras TurnLeft y TurnRight

Valor Description
ArriveFinish

Llegue al destino final.

ArriveIntermediate

Llega a un punto intermedio.

BearLeft

Bear left.

BearLeftThenBearLeft

El oso se dejó y luego el oso se dejó de nuevo.

BearLeftThenBearRight

Oso a la izquierda y luego oso a la derecha.

BearLeftThenTurnLeft

Oso a la izquierda y luego gire a la izquierda.

BearLeftThenTurnRight

Oso a la izquierda y luego gire a la derecha.

BearRight

Bear right.

BearRightThenBearLeft

Oso a la derecha y luego oso a la izquierda.

BearRightThenBearRight

Oso justo y luego oso de nuevo.

BearRightThenTurnLeft

Oso a la derecha y luego gire a la izquierda.

BearRightThenTurnRight

Oso a la derecha y luego gire a la derecha.

BearThenKeep

Oso instrucción y, a continuación, una instrucción keep

BearThenMerge

Lleve la instrucción y, a continuación, una instrucción de combinación.

Continue

Continúe en la carretera actual.

DepartIntermediateStop

Deje un punto de camino intermedio en una dirección y carretera diferente a la que llegó.

DepartIntermediateStopReturning

Deje un punto intermedio en la misma dirección y en la misma carretera en la que llegó.

DepartStart

Deje el punto de partida.

EnterRoundabout

Escriba un redondeo.

ExitRoundabout

Salga de una rotonda.

EnterThenExitRoundabout

Escriba y salga de una rotonda.

ExitRoundaboutRight

En la rotonda, tome la salida a la derecha.

ExitRoundaboutLeft

En la rotonda, tome la salida a la izquierda.

Follow

Follow.

GoAroundRoundabout

Ve por la rotonda.

KeepLeft

Mantente a la izquierda en otra carretera.

KeepOnRampLeft

Manténgase a la izquierda y continúe con la rampa.

KeepOnRampRight

Mantenga la derecha y continúe con la rampa.

KeepOnRampStraight

Mantenga recto y continúe en la rampa.

KeepRight

Mantenga la derecha sobre una carretera diferente.

KeepStraight

Mantente recta sobre una carretera diferente.

KeepToStayLeft

Mantente a la izquierda para permanecer en la misma carretera.

KeepToStayRight

Mantenga el derecho de permanecer en la misma carretera.

KeepToStayStraight

Siga directamente para permanecer en la misma carretera.

MergeFreeway

Combinar en una autopista.

MergeHighway

Combinar en una autopista.

MergeMotorway

Combinar en una autopista.

MotorwayExitLeft

Tome la salida izquierda.

MotorwayExitRight

Tome la salida correcta.

None

No instruction.

RampThenHighwayLeft

Tome la rampa izquierda a la autopista. Esto forma parte de una instrucción combinada.

RampThenHighwayRight

Tome la rampa derecha a la autopista. Esto forma parte de una instrucción combinada.

RampThenHighwayStraight

Manténgase directamente para tomar la rampa a la autopista. Esto forma parte de una instrucción combinada.

RoadNameChange

Cambia el nombre del camino.

SwitchToParallelRoad

Cambie a la carretera paralela.

SwitchToMainRoad

Cambie a la carretera principal.

Take

Tome el camino. Esta instrucción se usa cuando entras o sales de un ferry.

TakeFerry

Tome el ferry.

TakeExit

Tome la salida.

TakeRamp

Take ramp.

TakeRampLeft

Tome la rampa a la izquierda.

TakeRampRight

Tome la rampa a la derecha.

TakeRampStraight

Quédate directamente para tomar rampa.

TurnBack

Gire hacia atrás de forma aguda.

TurnLeft

Turn left.

TurnLeftSharp

Tome un giro a la izquierda afilado.

TurnLeftThenBearLeft

Gire a la izquierda y luego oso a la izquierda.

TurnLeftThenBearRight

Gire a la izquierda y, a continuación, oso a la derecha.

TurnLeftThenTurnLeft

Gire a la izquierda y vuelva a girar a la izquierda.

TurnLeftThenTurnRight

Gire a la izquierda y, a continuación, gire a la derecha.

TurnRight

Turn right.

TurnRightSharp

Tome un giro derecho afilado.

TurnRightThenBearLeft

Gire a la derecha y luego oso a la izquierda.

TurnRightThenBearRight

Gire a la derecha y luego oso a la derecha.

TurnRightThenTurnLeft

Gire a la derecha y, a continuación, gire a la izquierda.

TurnRightThenTurnRight

Gire a la derecha y vuelva a girar a la derecha

TurnThenMerge

Instrucciones de turno seguidas de una instrucción de combinación.

TurnToStayLeft

Gire a la izquierda para permanecer en la misma carretera.

TurnToStayRight

Gire a la derecha para permanecer en la misma carretera.

Unknown

La instrucción es desconocida.

UTurn

Haz un giro para ir en la dirección opuesta.

Wait

Wait

Walk

Walk

MapsErrorDetail

Detalle del error.

Nombre Tipo Description
code

string

Uno de un conjunto definido por el servidor de códigos de error.

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. For more information, see RFC 7946.

Nombre Tipo Description
coordinates

number[] (double)

Coordenadas de la geometría GeoJson MultiLineString.

type string:

MultiLineString

Especifica el tipo de geometría del objeto geometry GeoJSON. For more information, see RFC 7946.

OptimizedWaypoint

Objeto de punto de forma optimizado.

Nombre Tipo Description
inputIndex

integer (int64)

Índice de punto de acceso proporcionado por el usuario.

optimizedIndex

integer (int64)

Índice de punto de forma optimizado desde el sistema.

Order

Secuencia para visitar waypoints.

Nombre Tipo Description
inputIndex

integer (int64)

Índice proporcionado por el usuario para el punto de referencia

optimizedIndex

integer (int64)

System-optimized waypoint

PointGeometry

El punto de origen pasado como un objeto Geometry válido GeoJSON, desde el que se debe calcular el polígono de intervalo. Please refer to RFC 7946 for details.

Note: la API ajustará el punto de origen solicitado a la red de carreteras más cercana y la usará para el cálculo del intervalo. Se devolverá como punto de center en la respuesta.

Nombre Tipo Description
coordinates

number[] (double)

Un Position es una matriz de números con dos o más elementos. The first two elements are longitude and latitude, precisely in that order. Altitude/Elevation is an optional third element. Please refer to RFC 7946 for details.

type string:

Point

Especifica el tipo de geometría del objeto geometry GeoJSON. For more information, see RFC 7946.

RouteDirectionOptimizeRouteEnum

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.

Example: "optimizeRoute":"shortest"

Valor Description
shortest

La ruta se calcula para minimizar la distancia. No se usa la información de tráfico.

fastestWithoutTraffic

Busca la ruta más rápida, sin factorizar la información de tráfico.

fastestAvoidClosureWithoutTraffic
fastestWithTraffic

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.

RouteDirectionsResponse

Este objeto se devuelve de una llamada correcta.

Nombre Tipo Description
alternativeRoutes

FeatureCollection[]

Alternative route.

features

FeaturesItem[]

GeoJSON objeto de característica que contiene el objeto Geometry y propiedades adicionales. Para obtener más información, vea RFC 7946, Sección 3.2.

type

FeatureTypeEnum

Especifica el tipo de GeoJSON. El único tipo de objeto admitido es FeatureCollection. For more information, see RFC 7946.

RouteDirectionVehicleSpec

Especifica los atributos del vehículo, como el tamaño, el peso, la velocidad máxima, el tipo de carga, etc. solo para el enrutamiento de camiones. Esto ayuda a evitar bajas distancias de puente, restricciones de carretera, giros difíciles a la derecha para proporcionar la ruta optimizada del camión en función de las especificaciones del vehículo.

ISNote: solo se admite para truck travelMode.

Nombre Tipo Valor predeterminado Description
adrTunnelRestrictionCode

AdrTunnelRestrictionCodeEnum

Código de restricción del túnel ADR. ADR es un acuerdo europeo relativo al transporte internacional de mercancías peligrosas por carretera. El código de restricción del túnel ADR se utiliza para determinar si se permite que un vehículo pase a través de un túnel con restricciones sobre el transporte de mercancías peligrosas.

axleCount

integer (int64)

Número de ejes del vehículo.

axleWeight

integer (int64)

minimum: 0
maximum: 1000000
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 (double)

minimum: 0
maximum: 1000000
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 para fines comerciales. Es posible que los vehículos comerciales no puedan conducir en algunas carreteras.

length

number (double)

minimum: 0
maximum: 1000000
0

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

loadType

VehicleLoadTypeEnum[]

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

maxSpeed

integer (int64)

minimum: 0
maximum: 250
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 el planeamiento de rutas.

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

weight

integer (int64)

minimum: 0
maximum: 1000000
0

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

width

number (double)

minimum: 0
maximum: 1000000
0

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

RouteOutputOptionEnum

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", "itinerary"]

Valor Description
routeSummary

Incluya solo el tiempo de viaje y la distancia para la ruta y no proporcione otra información.

routePath

Incluya una GeoJSON MultiLineString RFC 7946, sección 3.1.5 que describa la ruta de acceso de la ruta en la respuesta.

itinerary

Incluya instrucciones detalladas en la respuesta. Las instrucciones detalladas se proporcionan como "Puntos de maniobra" y contienen detalles como instrucciones de turno a turno.

RoutePathPoint

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

Nombre Tipo Description
legIndex

integer (int64)

El índice de recorrido de ruta es un número secuencial asignado a cada tramo de la ruta para ayudar a identificar y distinguir entre distintos segmentos de la ruta.

pointIndex

integer (int64)

Í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
arrivalAt

string (date-time)

La hora estimada de llegada de la pierna, que tiene en cuenta las condiciones de tráfico, tiene el formato de un valor de dateTime definido por RFC 3339, sección 5.6. Hará referencia al desplazamiento de zona horaria mediante departAt o arrivalAt. Si no es así, se usará la hora UTC.

departureAt

string (date-time)

El tiempo de salida estimado 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 mediante 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 (int64)

Tiempo estimado de viaje en segundos que no incluye retrasos en la ruta debido a las condiciones de tráfico.

durationTrafficInSeconds

integer (int64)

El tiempo que tarda, en segundos, en viajar un TravelDistance correspondiente 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.

optimizedWaypoints

OptimizedWaypoint[]

Secuencia optimizada de puntos de referencia. Muestra el índice de la secuencia de punto de acceso proporcionada por el usuario para las listas originales y optimizadas.

trafficCongestion

TrafficCongestionEnum

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

type string:

RoutePath

Output type.

RoutePathRange

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

Nombre Tipo Description
legIndex

integer (int64)

El índice de recorrido de ruta es un número secuencial asignado a cada tramo de la ruta para ayudar a identificar y distinguir entre distintos segmentos de la ruta.

range

integer[] (int64)

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

RoutePathTravelModeEnum

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

Valor Description
driving

Rutas optimizadas para coches.

truck

Rutas optimizadas para camiones de gran tamaño en función de la especificación del vehículo.

walking

Rutas optimizadas para los peatones.

other

RouteAdvisorMode se devuelve como "otro" para el camión travelMode cuando la ruta del camión no está disponible para una sección determinada de una ruta.

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.

Valor Description
Left

Left.

Right

Right.

Unknown

Unknown.

Step

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

Nombre Tipo Description
maneuverType

ManeuverTypeEnum

Tipo de maniobra descrito en esta colección detallada. El Tipo de maniobra proporciona información para una parte de la maniobra especificada por la instrucción correspondiente. Por ejemplo, el tipo de maniobra de una instrucción puede especificar TurnLeftThenTurnRight, mientras que los elementos de detalle asociados pueden proporcionar detalles sobre las maniobras TurnLeft y TurnRight

names

string[]

Una 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 el nombre no se conoce o si una calle, carretera o intersección no tiene un nombre.

routePathRange

RoutePathRange

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

TrafficCongestionEnum

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

Valor Description
Unknown

Unknown.

None

None.

Mild

Mild.

Medium

Medium.

Heavy

Heavy.

TravelModeEnum

Modo de desplazamiento 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".

Example: "travelMode":"driving"

Valor Description
driving

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

truck

Las rutas devueltas están optimizadas para camiones de gran tamaño en función de la especificación del vehículo.

walking

Las rutas devueltas están optimizadas para los peatones, incluido el uso de aceras.

VehicleLoadTypeEnum

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

Valor Description
USHazmatClass1

Explosives

USHazmatClass2

Compressed gas

USHazmatClass3

Flammable liquids

USHazmatClass4

Flammable solids

USHazmatClass5

Oxidizers

USHazmatClass6

Poisons

USHazmatClass7

Radioactive

USHazmatClass8

Corrosives

USHazmatClass9

Miscellaneous

otherHazmatExplosive

Explosives

otherHazmatGeneral

Miscellaneous

otherHazmatHarmfulToWater

Perjudicial para el agua

WaypointProperties

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

Nombre Tipo Valor predeterminado Description
address

Address

El distrito administrativo y la región del país para los puntos de referencia y los puntos de maniobra en la ruta.

distanceInMeters

number

Distancia física en metros cubiertos por este paso de ruta.

durationInSeconds

integer (int64)

El tiempo que tarda, en segundos, en viajar un TravelDistancecorrespondiente.

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

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

RoutePathTravelModeEnum

driving

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

type string:

Waypoint

Output type.