Compartir a través de

Route - Post Directions

  • Referencia
Servicio:
Maps
Versión de la API:
2023-10-01-preview

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

La Route Directions API 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 para fines de navegación. La ruta considera 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 las leyes locales, dimensiones del 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 las mismas rutas que otros vehículos debido a ciertas restricciones basadas en el perfil del 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 camino y 10 viaWaypoints entre dos puntos de camino para conducir y caminar rutas. Cada conjunto de puntos de referencia crea un segmento 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 las piernas de ruta. 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 Azure Maps cobertura de enrutamiento.

Importante

Al usar esta característica, acepta los términos legales de la versión preliminar. Para obtener más información, consulte Versión preliminar de términos complementarios.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
api-version
 query True

string

Número de versión de la API de Azure Maps.

Encabezado de la solicitud

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 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.
Accept-Language

string

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

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

Cuerpo de la solicitud

Media Types: "application/geo+json"

Nombre Requerido Tipo Description
features True

InputWaypointFeaturesItem[]

Las rutas para conducir y caminar se definen mediante un conjunto de puntos de camino (paradas) y viaWaypoints (ubicaciones intermedias a las que debe pasar la ruta). Puede tener un máximo de 25 puntos de acceso y un máximo de 10 viaWaypoints entre cada conjunto de puntos de camino. La ruta del camión admite hasta 150 puntos de acceso y viaWaypoints no se admiten.

Una ruta debe tener un mínimo de 2 puntos de ruta y los puntos iniciales y finales de la ruta no pueden ser viaWaypoints.

Tanto el punto de acceso como las ubicaciones viaWaypoint deben especificarse como un objeto de característica De punto GeoJSON válido junto con pointIndex que especifica el orden de las ubicaciones. Para obtener más información sobre el formato GeoJSON, consulte RFC 7946.
type True

FeatureTypeEnum

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

string

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

El arriveAt valor debe estar en el futuro. El arriveAt parámetro no se puede usar junto con departAt.

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

Avoid[]

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

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

string

Fecha y hora de salida del punto de origen con formato de dateTime valor definido por RFC 3339, sección 5.6. Cuando no se especifica un desplazamiento de zona horaria, se supone que utc.

El departAt valor debe estar en el futuro en el formato de fecha y hora o ahora valor para establecerlo en la hora actual.

Ejemplos:

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

integer

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

integer

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

En el caso de las rutas de conducción, este parámetro admite rutas con hasta dos puntos de camino, además del origen y el destino, y no se debe establecer el parámetro avoid.

Valor predeterminado: "maxRouteCount":1

Mínimo: "maxRouteCount":1

Máximo: "maxRouteCount":3
optimizeRoute

OptimizeRoute

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

Ejemplo: "optimizeRoute":"shortest"
optimizeWaypointOrder

boolean

Vuelva a ordenar los puntos de ruta mediante un algoritmo heurístico rápido para reducir el costo de ruta especificado con el parámetro optimize. El origen y el destino se excluyen del punto de acceso optimizado y su posición se considera fija. Los valores aceptables son true o false.

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

RouteOutputOption[]

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

Admite varios valores como "routeOutputOptions": ["routePath", "regionTravelSummary"]
travelMode

TravelMode

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

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

Ejemplo: "travelMode":"driving"
vehicleSpec

VehicleSpec

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

Note: solo se admite para travelMode de camión

Respuestas

Nombre Tipo Description
200 OK

RouteDirectionsResponse

Aceptar

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 Microsoft Entra flujos de OAuth 2.0. 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. Se puede conceder acceso a cualquier usuario, grupo o entidad de servicio 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 modelar aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.

Nota

  • Esta definición de seguridad requiere el uso del x-ms-client-id encabezado para indicar a qué recurso Azure Maps la aplicación solicita acceso. Esto se puede adquirir desde la API de administración de Maps.
  • Authorization URL es específico de la instancia de nube pública de Azure. Las nubes soberanas tienen direcciones URL de autorización únicas y configuraciones de Microsoft Entra ID.
  • El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure mediante Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST.
  • El uso del SDK web de Azure Maps permite la configuración basada en la configuración de una aplicación para varios casos de uso.
  • Para obtener más información sobre Plataforma de identidad de Microsoft, consulte introducción a 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 un recurso de Azure Maps a través del plano de administración de Azure mediante Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST.

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

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es usar el acceso de servidor a servidor de Azure Maps API REST en las que 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 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.

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=2023-10-01-preview

{
  "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

status code:
200 
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.20147,
          47.608676
        ]
      },
      "properties": {
        "type": "Waypoint",
        "routePathPoint": {
          "legIndex": 0,
          "pointIndex": 0
        },
        "order": {
          "inputIndex": 0
        },
        "compassDirection": "north",
        "instruction": {
          "formattedText": "<Action>Head</Action> <CmpsDir>north</CmpsDir> on <RoadName>Bellevue Way SE</RoadName> toward <Toward>SE 1st St</Toward>",
          "maneuverType": "DepartStart",
          "text": "Head north on Bellevue Way SE toward SE 1st St"
        },
        "sideOfStreet": "Unknown",
        "towardsRoadName": "SE 1st St",
        "distanceInMeters": 98.2,
        "durationInSeconds": 19,
        "steps": [
          {
            "routePathRange": {
              "legIndex": 0,
              "range": [
                0,
                1
              ]
            },
            "maneuverType": "DepartStart",
            "compassDegrees": 358,
            "roadType": "Arterial",
            "names": [
              "Bellevue Way SE"
            ]
          }
        ],
        "travelMode": "driving"
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.201495,
          47.610109
        ]
      },
      "properties": {
        "type": "ManeuverPoint",
        "routePathPoint": {
          "legIndex": 0,
          "pointIndex": 1
        },
        "compassDirection": "north",
        "instruction": {
          "formattedText": "<Action>Turn</Action> <TurnDir>left</TurnDir> onto <RoadName>Main st</RoadName>",
          "maneuverType": "TurnLeft",
          "text": "Turn left onto Main st"
        },
        "sideOfStreet": "Unknown",
        "distanceInMeters": 253.5,
        "durationInSeconds": 81,
        "steps": [
          {
            "routePathRange": {
              "legIndex": 0,
              "range": [
                1,
                3
              ]
            },
            "maneuverType": "TurnLeft",
            "compassDegrees": 358,
            "roadType": "Arterial",
            "names": [
              "Main st"
            ]
          }
        ],
        "travelMode": "driving"
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.206817,
          47.610185
        ]
      },
      "properties": {
        "type": "ManeuverPoint",
        "routePathPoint": {
          "legIndex": 0,
          "pointIndex": 3
        },
        "compassDirection": "north",
        "instruction": {
          "formattedText": "<Action>Turn</Action> <TurnDir>right</TurnDir> onto <RoadName>100th Ave NE</RoadName>",
          "maneuverType": "TurnRight",
          "text": "Turn right onto 100th Ave NE"
        },
        "sideOfStreet": "Unknown",
        "distanceInMeters": 252.9,
        "durationInSeconds": 49,
        "steps": [
          {
            "routePathRange": {
              "legIndex": 0,
              "range": [
                3,
                5
              ]
            },
            "maneuverType": "TurnRight",
            "compassDegrees": 357,
            "roadType": "Arterial",
            "names": [
              "100th Ave NE"
            ]
          }
        ],
        "travelMode": "driving"
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.206971,
          47.61384
        ]
      },
      "properties": {
        "type": "ManeuverPoint",
        "routePathPoint": {
          "legIndex": 0,
          "pointIndex": 6
        },
        "compassDirection": "east",
        "instruction": {
          "formattedText": "<Action>Turn</Action> <TurnDir>right</TurnDir> onto <RoadName>NE 4th St</RoadName>",
          "maneuverType": "TurnRight",
          "text": "Turn right onto NE 4th St"
        },
        "sideOfStreet": "Unknown",
        "distanceInMeters": 247.9,
        "durationInSeconds": 77,
        "steps": [
          {
            "routePathRange": {
              "legIndex": 0,
              "range": [
                6,
                9
              ]
            },
            "maneuverType": "TurnRight",
            "compassDegrees": 90,
            "roadType": "Arterial",
            "names": [
              "NE 4th St"
            ]
          }
        ],
        "travelMode": "driving"
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.201664,
          47.61386
        ]
      },
      "properties": {
        "type": "ManeuverPoint",
        "routePathPoint": {
          "legIndex": 0,
          "pointIndex": 9
        },
        "compassDirection": "east",
        "instruction": {
          "formattedText": "<Action>Turn</Action> <TurnDir>left</TurnDir> onto <RoadName>Bellevue Way NE</RoadName>",
          "maneuverType": "TurnLeft",
          "text": "Turn left onto Bellevue Way NE"
        },
        "sideOfStreet": "Unknown",
        "distanceInMeters": 94.4,
        "durationInSeconds": 38,
        "steps": [
          {
            "routePathRange": {
              "legIndex": 0,
              "range": [
                9,
                11
              ]
            },
            "maneuverType": "TurnLeft",
            "compassDegrees": 91,
            "roadType": "Arterial",
            "names": [
              "Bellevue Way NE"
            ]
          }
        ],
        "travelMode": "driving"
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.201603,
          47.615137
        ]
      },
      "properties": {
        "type": "Waypoint",
        "routePathPoint": {
          "legIndex": 0,
          "pointIndex": 11
        },
        "order": {
          "inputIndex": 2
        },
        "compassDirection": "north",
        "instruction": {
          "formattedText": "<Action>Arrive</Action> at <WaypointName>Bellevue Way NE</WaypointName>",
          "maneuverType": "ArriveFinish",
          "text": "Arrive at Bellevue Way NE",
          "hints": [
            {
              "hintType": "PreviousIntersection",
              "text": "The last intersection before your destination is NE 4th St"
            }
          ]
        },
        "sideOfStreet": "Unknown",
        "distanceInMeters": 0,
        "durationInSeconds": 0,
        "steps": [
          {
            "routePathRange": {
              "legIndex": 0,
              "range": [
                11,
                11
              ]
            },
            "maneuverType": "ArriveFinish",
            "compassDegrees": 357,
            "roadType": "Arterial",
            "names": [
              "Bellevue Way NE"
            ]
          }
        ],
        "travelMode": "driving"
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.206894,
          47.612001
        ]
      },
      "properties": {
        "type": "ViaWaypoint",
        "names": [
          "100th Ave NE"
        ],
        "routePathPoint": {
          "pointIndex": 5,
          "legIndex": 0
        },
        "order": {
          "inputIndex": 1
        }
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "MultiLineString",
        "coordinates": [
          [
            [
              -122.20147,
              47.608675
            ],
            [
              -122.201494,
              47.610108
            ],
            [
              -122.201496,
              47.610196
            ],
            [
              -122.206817,
              47.610185
            ],
            [
              -122.206824,
              47.610369
            ],
            [
              -122.206893,
              47.612001
            ],
            [
              -122.20697,
              47.613839
            ],
            [
              -122.206832,
              47.613839
            ],
            [
              -122.204428,
              47.61379
            ],
            [
              -122.201664,
              47.61386
            ],
            [
              -122.201547,
              47.613857
            ],
            [
              -122.201603,
              47.615137
            ]
          ]
        ]
      },
      "bbox": [
        47.608676,
        -122.206971,
        47.615137,
        -122.20147
      ],
      "properties": {
        "type": "RoutePath",
        "resourceId": "v70,h-1241513931,i0,a0,cen-US,dAMA8xD0s2wg1,y1,s3,m1,o1,t4,wuOUjKenNR0CdnKG444xewA2~AISjUSdxkDoBAADgAdG_yz4A0~QmVsbGV2dWUgV2F5IFNF0~~~~~~~~v12,wFYvfFFbOR0CBIatbPY1ewA2~AISjUScpizoBAADgARBojT4A0~MTAwdGggQXZlIE5F0~~~1~~~~~v12,w-kZ0z7rOR0B95xcl6IxewA2~AISjUSchJDoBAADgAQAAgD8A0~QmVsbGV2dWUgV2F5IE5F0~~~~~~~~v12,k0,qatt:1",
        "distanceInMeters": 947,
        "durationInSeconds": 266,
        "durationTrafficInSeconds": 295,
        "trafficDataUsed": "None",
        "trafficCongestion": "Mild",
        "departureTime": "2023-08-28T18:00:00+00:00",
        "arrivalTime": "2023-08-28T18:04:55+00:00",
        "legs": [
          {
            "description": "100th Ave NE, NE 4th St",
            "routePathRange": {
              "range": [
                0,
                11
              ],
              "legIndex": 0
            },
            "subLegs": [
              {
                "routePathRange": {
                  "range": [
                    0,
                    5
                  ],
                  "legIndex": 0
                },
                "distanceInMeters": 477.8,
                "durationInSeconds": 128,
                "durationTrafficInSeconds": 138
              },
              {
                "routePathRange": {
                  "range": [
                    5,
                    11
                  ],
                  "legIndex": 0
                },
                "distanceInMeters": 469.1,
                "durationInSeconds": 137,
                "durationTrafficInSeconds": 157
              }
            ],
            "distanceInMeters": 947,
            "durationInSeconds": 266,
            "durationTrafficInSeconds": 295,
            "departureTime": "2023-08-28T18:00:00+00:00",
            "arrivalTime": "2023-08-28T18:04:55+00:00"
          }
        ]
      }
    }
  ]
}

Definiciones

Nombre Description
AdminDistrict

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

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

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

Este objeto es el cuerpo de la solicitud.
FeatureCollection

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

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

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

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

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

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

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

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

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

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

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

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

Detalle del error.
MapsErrorResponse

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

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

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

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

Ejemplo: "optimizeRoute":"shortest"
Order

Secuencia para visitar los puntos de acceso y viaWaypoints.
PointGeometry

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

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

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

Este objeto se devuelve de una llamada correcta.
RouteOutputOption

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

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

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

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

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

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

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

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

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

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

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

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

Ejemplo: "travelMode":"driving"
VehicleLoadType

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

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

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

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

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

AdminDistrict

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

Nombre Tipo Description
distanceInMeters

number

Distancia total recorrida en metros dentro del distrito administrativo.
durationInSeconds

integer

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

integer

El tiempo que tarda, en segundos, en viajar un correspondiente TravelDistance con las condiciones de tráfico actuales. Este valor se proporciona si optimizeRoute incluye consideraciones sobre el tráfico.
longName

string

Nombre largo de una dirección, como Washington.

Avoid

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

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

Nombre Tipo Description
borderCrossings

string

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

string

Evita el uso de ferris en la ruta.
limitedAccessHighways

string

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

string

Evita zonas de baja emisión en la ruta. Note: solo se admite para travelMode de camión.
tollRoads

string

Evita el uso de carreteras de peaje en la ruta.
tunnels

string

Evita el uso de túneles en la ruta. Note: solo se admite para travelMode de camión.
unpavedRoads

string

Evita carreteras sin pintar en la ruta. Note: solo se admite para travelMode de camión.

DirectionsRequest

Este objeto es el cuerpo de la solicitud.

Nombre Tipo Valor predeterminado Description
arriveAt

string

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

El arriveAt valor debe estar en el futuro. El arriveAt parámetro no se puede usar junto con departAt.

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

Avoid[]

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

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

string

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

El departAt valor debe estar en el futuro en el formato de fecha y hora o ahora para establecerlo en la hora actual.

Ejemplos:

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

InputWaypointFeaturesItem[]

Las rutas para conducir y caminar se definen mediante un conjunto de puntos de referencia (paradas) y viaWaypoints (ubicaciones intermedias a las que debe pasar la ruta). Puede tener un máximo de 25 puntos de referencia y un máximo de 10 viaWaypoints entre cada conjunto de puntos de referencia. La ruta de camión admite hasta 150 puntos de referencia y viaWaypoints no se admite.

Una ruta debe tener un mínimo de 2 puntos de referencia y los puntos inicial y final de la ruta no pueden ser viaWaypoints.

Las ubicaciones waypoint y viaWaypoint deben especificarse como un objeto de característica geoJSON Point válido junto con pointIndex que especifica el orden de las ubicaciones. Para obtener más información sobre el formato GeoJSON, consulte RFC 7946.
heading

integer

El encabezado direccional inicial del vehículo en grados comenzando en el verdadero Norte y continuando en dirección en sentido de las agujas del reloj. El norte es de 0 grados, este es de 90 grados, sur es de 180 grados, oeste es de 270 grados. Valores posibles entre 0 y 359
maxRouteCount

integer

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

En el caso de las rutas de conducción, este parámetro admite rutas con hasta dos puntos de referencia, además del origen y el destino, y no se debe establecer el parámetro avoid.

Valor predeterminado: "maxRouteCount":1

Mínimo: "maxRouteCount":1

Máximo: "maxRouteCount":3
optimizeRoute

OptimizeRoute

fastestWithoutTraffic

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

Ejemplo: "optimizeRoute":"shortest"
optimizeWaypointOrder

boolean

False

Vuelva a ordenar los puntos de ruta mediante un algoritmo heurístico rápido para reducir el costo de ruta especificado con el parámetro optimize. El origen y el destino se excluyen del punto de referencia optimizado y su posición se considera fija. Los valores aceptables son true o false.

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

RouteOutputOption[]

[ "itinerary" ]

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

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

TravelMode

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

Ejemplo: "travelMode":"driving"
type

FeatureTypeEnum

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

VehicleSpec

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

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

FeatureCollection

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

Nombre Tipo Description
features

FeaturesItem[]

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

string

es el vínculo a la página siguiente de las características devueltas. Si es la última página, el campo no existirá.
type

FeatureTypeEnum

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

FeaturesItem

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

Nombre Tipo Description
bbox

number[]

Un área rectangular en la tierra definida como un objeto de rectángulo delimitador. Los lados de los rectángulos se definen mediante valores de latitud y longitud. Para obtener más información, vea RFC 7946, Sección 5.

Ejemplo: "bbox": [-10.0, -10.0, 10.0, 10.0]
geometry Geometry:

Objeto Geometry válido GeoJSON . Para obtener más información, consulte RFC 7946.
properties FeatureProperties:

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

FeaturesItemTypeEnum

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

FeaturesItemTypeEnum

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

Nombre Tipo Description
Feature

string

Especifica el GeoJSON tipo de objeto Feature.

FeatureTypeEnum

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

Nombre Tipo Description
FeatureCollection

string

Especifica el tipo de GeoJSONFeatureCollection objeto.

GeoJsonPoint

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

Nombre Tipo Description
coordinates

number[]

A Position es una matriz de números con dos o más elementos. Los dos primeros elementos son longitud y latitud, precisamente en ese orden. Altitud/Elevación es un tercer elemento opcional. Consulte RFC 7946 para obtener más información.
type string:

Point

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

Hint

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

Nombre Tipo Description
hintType

string

tipo de sugerencia.
text

string

texto de sugerencia.

InputWaypointFeaturesItem

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

Nombre Tipo Valor predeterminado Description
geometry GeoJsonPoint:

PointGeometry

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

integer

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

InputWaypointTypeEnum

waypoint

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

FeaturesItemTypeEnum

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

InputWaypointTypeEnum

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

Nombre Tipo Description
viaWaypoint

string

Un viaWaypoint es un punto de referencia específico que debe pasarse o visitarse a lo largo de una ruta o un viaje. Note: solo se admite para conducir travelMode.
waypoint

string

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

Instruction

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

Nombre Tipo Description
formattedText

string

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

Hint[]

Información adicional que puede resultar útil al seguir una ruta. Además del texto de la sugerencia, este elemento tiene un atributo hintType que especifica a qué hace referencia la sugerencia, como "NextIntersection". Hint es un elemento opcional y un paso de ruta puede contener más de una sugerencia. Note: solo se admite para conducir travelMode.
maneuverType

ManeuverTypeEnum

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

string

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

Leg

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

Nombre Tipo Description
arrivalTime

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

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

string

Una breve descripción de la ruta.
distanceInMeters

number

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

integer

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

integer

El tiempo que tarda, en segundos, en viajar un correspondiente TravelDistance con las condiciones de tráfico actuales. Este valor se proporciona si optimizeRoute incluye consideraciones sobre el tráfico.
regionTravelSummary

RegionTravelSummary

Incluya el resumen de viajes de distancia, tiempo y distancia de carretera de peaje por dos tipos de entidad: país (por ejemplo, EE. UU., Canadá) y división administrativa o subdivisión (por ejemplo, "estado" en ESTADOS UNIDOS y "provincia" en Canadá).
routePathRange

RoutePathRange

Hace referencia al intervalo cubierto por un tramo específico de una ruta o un trazado.
subLegs

SubLeg[]

Información sobre los segmentos del segmento de ruta definidos por los puntos de ruta de las piernas de ruta y los puntos intermedios a través de los puntos de referencia. Por ejemplo, si el segmento de ruta tiene dos puntos via way, además de los puntos de referencia inicial y final, habría tres (3) subcarpetas de ruta.

ManeuverPointProperties

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

Nombre Tipo Valor predeterminado Description
compassDirection

string

Dirección del viaje asociada a una maniobra en una ruta, como sur o suroeste. Note: solo se admite para conducir travelMode.
distanceInMeters

number

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

integer

Tiempo que tarda, en segundos, en viajar un objeto correspondiente TravelDistance.
exitIdentifier

string

Nombre o número de la salida asociada a este paso de ruta.
instruction

Instruction

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

Order

Secuencia para visitar los puntos de acceso y viaWaypoints.
routePathPoint

RoutePathPoint

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

SideOfStreetEnum

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

string[]

Texto de señalización para la ruta. Puede haber más de un valor de signo.
steps

Step[]

Pasos entre dos puntos de maniobra consecutivos.
towardsRoadName

string

Nombre de la calle hacia la que va la ruta en el primer ManeuverPoint.
travelMode

RouteTravelMode

driving

Modo de desplazamiento para la ruta de acceso de ruta en la respuesta.
type string:

ManeuverPoint

Tipo de salida.

ManeuverTypeEnum

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

Nombre Tipo Description
ArriveFinish

string

Llegue al destino final.
ArriveIntermediate

string

Llega a un punto de referencia intermedio.
BearLeft

string

Oso a la izquierda.
BearLeftThenBearLeft

string

Oso se dejó y luego se dejó otra vez.
BearLeftThenBearRight

string

Oso a la izquierda y luego oso a la derecha.
BearLeftThenTurnLeft

string

Oso a la izquierda y luego gire a la izquierda.
BearLeftThenTurnRight

string

Oso a la izquierda y luego gire a la derecha.
BearRight

string

Oso a la derecha.
BearRightThenBearLeft

string

Oso a la derecha y luego oso a la izquierda.
BearRightThenBearRight

string

Oso a la derecha y luego oso de nuevo.
BearRightThenTurnLeft

string

Oso a la derecha y luego gire a la izquierda.
BearRightThenTurnRight

string

Oso a la derecha y luego gire a la derecha.
BearThenKeep

string

Instrucción bear y, a continuación, una instrucción keep
BearThenMerge

string

Instrucción de oso y, a continuación, una instrucción de combinación.
Continue

string

Continúe en la carretera actual.
DepartIntermediateStop

string

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

string

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

string

Deje el punto de partida.
EnterRoundabout

string

Escriba un roundabout.
EnterThenExitRoundabout

string

Escriba y salga de una rotonda.
ExitRoundabout

string

Salga de una rotonda.
ExitRoundaboutLeft

string

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

string

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

string

Seguir.
GoAroundRoundabout

string

Ve por la rotonda.
KeepLeft

string

Mantente a la izquierda en otra carretera.
KeepOnRampLeft

string

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

string

Manténgase a la derecha y continúe en la rampa.
KeepOnRampStraight

string

Siga recto y continúe en la rampa.
KeepRight

string

Manténgase a la derecha en otra carretera.
KeepStraight

string

Mantente recto en una carretera diferente.
KeepToStayLeft

string

Manténgase a la izquierda para permanecer en la misma carretera.
KeepToStayRight

string

Mantenga el derecho de permanecer en la misma carretera.
KeepToStayStraight

string

Manténgase recto para permanecer en la misma carretera.
MergeFreeway

string

Combinar en una autopista.
MergeHighway

string

Combinar en una autopista.
MergeMotorway

string

Combinar en una autopista.
MotorwayExitLeft

string

Tome la salida izquierda.
MotorwayExitRight

string

Tome la salida derecha.
None

string

Sin instrucciones.
RampThenHighwayLeft

string

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

string

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

string

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

string

Cambios en el nombre del camino.
SwitchToMainRoad

string

Cambie a la carretera principal.
SwitchToParallelRoad

string

Cambie a la carretera paralela.
Take

string

Tome el camino. Esta instrucción se utiliza al entrar o salir de un ferry.
TakeExit

string

Tome la salida.
TakeFerry

string

Tome el ferry.
TakeRamp

string

Toma rampa.
TakeRampLeft

string

Tome rampa a la izquierda.
TakeRampRight

string

Tome rampa a la derecha.
TakeRampStraight

string

Quédate directamente para tomar rampa.
TurnBack

string

Retroceda fuertemente.
TurnLeft

string

Gire a la izquierda.
TurnLeftSharp

string

Tome un giro a la izquierda afilado.
TurnLeftThenBearLeft

string

Gire a la izquierda y luego oso a la izquierda.
TurnLeftThenBearRight

string

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

string

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

string

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

string

Gire a la derecha.
TurnRightSharp

string

Tome un giro derecho afilado.
TurnRightThenBearLeft

string

Gire a la derecha y luego oso a la izquierda.
TurnRightThenBearRight

string

Gire a la derecha y luego oso derecho.
TurnRightThenTurnLeft

string

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

string

Gire a la derecha y vuelva a girar a la derecha
TurnThenMerge

string

Instrucción turn seguida de una instrucción de combinación.
TurnToStayLeft

string

Gire a la izquierda para permanecer en la misma carretera.
TurnToStayRight

string

Gire a la derecha para permanecer en la misma carretera.
UTurn

string

Haga un giro para ir en la dirección opuesta.
Unknown

string

La instrucción es desconocida.
Wait

string

Esperar
Walk

string

A pie

MapsErrorDetail

Detalle del error.

Nombre Tipo Description
code

string

Uno de los conjuntos de códigos de error definidos por el servidor.
details

MapsErrorDetail[]

Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror

MapsInnerError

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

string

Representación legible del error.
target

string

Destino del error.

MapsErrorResponse

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

Nombre Tipo Description
error

MapsErrorDetail

Detalle del error.

MapsInnerError

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

Nombre Tipo Description
code

string

Código de error.
innererror

MapsInnerError

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

MultiLineStringGeometry

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

Nombre Tipo Description
coordinates

number[]

Coordenadas de la GeoJson MultiLineString geometría.
type string:

MultiLineString

Especifica el tipo de geometría para el objeto Geometry 'GeoJSON'. Para obtener más información, consulte RFC 7946.

OptimizeRoute

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

Ejemplo: "optimizeRoute":"shortest"

Nombre Tipo Description
fastestAvoidClosureWithoutTraffic

string

La ruta se calcula para minimizar el tiempo y evitar cierres de carreteras. No se utiliza información de tráfico excepto los cierres de carreteras en el cálculo. Note: solo se admite para conducir travelMode.
fastestWithTraffic

string

La ruta se calcula para minimizar el tiempo mediante la información de tráfico actual. Note: solo se admite para conducir y camión travelMode.
fastestWithoutTraffic

string

Busca la ruta más rápida, sin tener en cuenta la información de tráfico.
shortest

string

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

Order

Secuencia para visitar los puntos de acceso y viaWaypoints.

Nombre Tipo Description
inputIndex

integer

Índice proporcionado por el usuario para las entradas waypoint y viaWaypoint.
optimizedIndex

integer

Punto de acceso optimizado para el sistema y el índice viaWaypoint.

PointGeometry

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

Nombre Tipo Description
coordinates

number[]

Un Position es una matriz de números con dos o más elementos. Los dos primeros elementos son longitud y latitud, precisamente en ese orden. Altitud/Elevación es un tercer elemento opcional. Consulte RFC 7946 para obtener más información.
type string:

Point

Especifica el tipo de geometría para el objeto Geometry 'GeoJSON'. Para obtener más información, consulte RFC 7946.

RegionTravelSummary

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

Nombre Tipo Description
adminDistricts

AdminDistrict[]

adminDistrict array.
countryRegion

string

Nombre de la región del país.
distanceInMeters

number

Length In Meters (propiedad)
durationInSeconds

integer

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

integer

El tiempo que tarda, en segundos, en viajar un correspondiente TravelDistance con las condiciones de tráfico actuales. Este valor se proporciona si optimizeRoute incluye consideraciones sobre el tráfico.

RoadTypeEnum

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

Nombre Tipo Description
Arterial

string

Arterial.
Ferry

string

Ferry.
Highway

string

Carretera.
LimitedAccessHighway

string

LimitedAccessHighway.
MajorRoad

string

MajorRoad.
NotApplicable

string

NotApplicable.
Ramp

string

Rampa.
Street

string

Calle.
WalkingPath

string

WalkingPath.

RouteDirectionsResponse

Este objeto se devuelve de una llamada correcta.

Nombre Tipo Description
alternativeRoutes

FeatureCollection[]

Ruta alternativa.
features

FeaturesItem[]

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

string

es el vínculo a la página siguiente de las características devueltas. Si es la última página, el campo no existirá.
type

FeatureTypeEnum

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

RouteOutputOption

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

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

Nombre Tipo Description
itinerary

string

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

string

Incluya el resumen de viajes de distancia, tiempo y distancia de carretera de peaje por dos tipos de entidad: país (por ejemplo, EE.UU., Canadá) y división administrativa o subdivisión (por ejemplo, "estado" en ESTADOS UNIDOS y "provincia" en Canadá). Note: solo se admite para conducir y caminar travelMode
routePath

string

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

string

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

RoutePathPoint

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

Nombre Tipo Description
legIndex

integer

El índice route Leg es un número secuencial asignado a cada segmento de la ruta para ayudar a identificar y distinguir entre diferentes segmentos de la ruta.
pointIndex

integer

Índice de un punto dentro de una pierna específica.

RoutePathProperties

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

Nombre Tipo Description
arrivalTime

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

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

number

Distancia física en metros cubiertos por toda la ruta.
durationInSeconds

integer

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

integer

El tiempo que tarda, en segundos, en viajar un correspondiente TravelDistance con las condiciones de tráfico actuales. Este valor se proporciona si optimizeRoute incluye consideraciones sobre el tráfico.
legs

Leg[]

Matriz de piernas de ruta. Consulte la descripción del objeto Route Leg para obtener más información.
resourceId

string

Identificador único del recurso.
trafficCongestion

TrafficCongestionEnum

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

TrafficDataUsedEnum

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

RoutePath

Tipo de salida.

RoutePathRange

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

Nombre Tipo Description
legIndex

integer

El índice route Leg es un número secuencial asignado a cada segmento de la ruta para ayudar a identificar y distinguir entre diferentes segmentos de la ruta.
range

integer[]

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

RouteTravelMode

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

Nombre Tipo Description
driving

string

Rutas optimizadas para automóviles.
other

string

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

string

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

string

Rutas optimizadas para los peatonales.

SideOfStreetEnum

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

Nombre Tipo Description
Left

string

Izquierda.
Right

string

Bien.
Unknown

string

desconocida.

Step

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

Nombre Tipo Description
compassDegrees

number

Dirección en grados. Note: solo se admite para conducir travelMode.
maneuverType

ManeuverTypeEnum

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

string[]

Calle, autopista o intersección donde se produce la maniobra. Si la maniobra es compleja, puede haber más de un campo de nombre en la colección de detalles. El campo de nombre también puede no tener ningún valor. Esto puede ocurrir si no se conoce el nombre o si una calle, carretera o intersección no tiene un nombre.
roadType

RoadTypeEnum

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

RoutePathRange

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

SubLeg

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

Nombre Tipo Description
distanceInMeters

number

Distancia física en metros cubiertos por la sub-pierna.
durationInSeconds

integer

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

integer

El tiempo que tarda, en segundos, en viajar un correspondiente TravelDistance con las condiciones de tráfico actuales. Este valor se proporciona si optimizeRoute incluye consideraciones sobre el tráfico.
routePathRange

RoutePathRange

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

TrafficCongestionEnum

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

Nombre Tipo Description
Heavy

string

Pesado.
Medium

string

Mediana.
Mild

string

Suave.
None

string

Ninguno.
Unknown

string

desconocida.

TrafficDataUsedEnum

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

Nombre Tipo Description
Closure

string

Datos de cierre en tiempo real utilizados, si procede.
Flow

string

Velocidades de tráfico en tiempo real usadas para calcular el tiempo de desplazamiento.
FlowAndClosure

string

Flujo y cierre.
None

string

Ninguno.

TravelMode

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

Ejemplo: "travelMode":"driving"

Nombre Tipo Description
driving

string

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

string

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

string

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

VehicleLoadType

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

Nombre Tipo Description
USHazmatClass1

string

Explosivos
USHazmatClass2

string

Gas comprimido
USHazmatClass3

string

Líquidos inflamables
USHazmatClass4

string

Sólidos inflamables
USHazmatClass5

string

Oxidantes
USHazmatClass6

string

Venenos
USHazmatClass7

string

Material radiactivo
USHazmatClass8

string

Corrosivos
USHazmatClass9

string

Disposiciones adicionales
otherHazmatExplosive

string

Explosivos
otherHazmatGeneral

string

Disposiciones adicionales
otherHazmatHarmfulToWater

string

Perjudicial para el agua

VehicleSpec

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

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

Nombre Tipo Valor predeterminado Description
axleCount

integer

0

Número de ejes en el vehículo. Un valor de 0 significa que no se tienen en cuenta las restricciones de ejes.
axleWeight

integer

0

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

number

0

Altura del vehículo en metros. Un valor de 0 significa que no se tienen en cuenta las restricciones de altura.
isVehicleCommercial

boolean

False

Si el vehículo se utiliza con fines comerciales. Es posible que los vehículos comerciales no puedan conducir en algunas carreteras.
length

number

0

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

VehicleLoadType[]

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

integer

0

Velocidad máxima del vehículo en km/hora. La velocidad máxima en el perfil del vehículo se utiliza para comprobar si se permite un vehículo en las autopistas.

Un valor de 0 significa que se determinará y aplicará un valor adecuado para el vehículo durante la planificación de rutas.

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

integer

0

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

number

0

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

ViaWaypointProperties

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

Nombre Tipo Description
names

string[]

Calle, autopista o intersección donde se produce la maniobra. Si la maniobra es compleja, puede haber más de un campo de nombre en la colección de detalles. El campo de nombre también puede no tener ningún valor. Esto puede ocurrir si no se conoce el nombre o si una calle, carretera o intersección no tiene un nombre.
order

Order

Secuencia para visitar los puntos de acceso y viaWaypoints.
routePathPoint

RoutePathPoint

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

ViaWaypoint

Tipo de salida.

WaypointProperties

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

Nombre Tipo Valor predeterminado Description
compassDirection

string

Dirección del viaje asociada a una maniobra en una ruta, como sur o suroeste. Note: solo se admite para conducir travelMode.
distanceInMeters

number

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

integer

Tiempo que tarda, en segundos, en viajar un objeto correspondiente TravelDistance.
exitIdentifier

string

Nombre o número de la salida asociada a este paso de ruta.
instruction

Instruction

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

Order

Secuencia para visitar los puntos de acceso y viaWaypoints.
routePathPoint

RoutePathPoint

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

SideOfStreetEnum

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

string[]

Texto de señalización para la ruta. Puede haber más de un valor de signo.
steps

Step[]

Pasos entre dos puntos de maniobra consecutivos.
towardsRoadName

string

Nombre de la calle hacia la que va la ruta en el primer ManeuverPoint.
travelMode

RouteTravelMode

driving

Modo de desplazamiento para la ruta de acceso de ruta en la respuesta.
type string:

Waypoint

Tipo de salida.