Partilhar via

Route - Post Route Directions Batch

Serviço:
Maps
Versão da API:
2025-01-01

Use para enviar um lote de consultas para a API de Direções de Rota em uma única solicitação síncrona.

A Route Directions Batch API é uma solicitação HTTP POST que envia lotes de até 100 consultas em uma única chamada para a API de Direções de Rota .

Enviar solicitação de lote síncrona

A API síncrona é recomendada para solicitações em lote leves. Quando o serviço recebe uma solicitação, ele responderá assim que os itens do lote forem calculados e não haverá possibilidade de recuperar os resultados posteriormente. A API síncrona retornará um erro de tempo limite (uma resposta 408) se a solicitação demorar mais de 60 segundos. O número de itens de lote é limitado a 100 para esta API.

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

Corpo POST para solicitação de lote

Para enviar as consultas de direções , você usará uma POST solicitação em que o corpo da solicitação conterá a batchItems matriz no json formato e o Content-Type cabeçalho será definido como application/json. Aqui está um corpo de solicitação de exemplo contendo 2 consultas de instruções :

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

Um objeto directions batchItem pode aceitar qualquer uma das direções suportadas Corpo da solicitação

O lote deve conter pelo menos 1 consulta.

Modelo de resposta em lote

A resposta em lote contém um componente summary que indica os totalRequests que faziam parte da solicitação de lote original e successfulRequests ou seja, consultas que foram executadas com êxito. A resposta em lote também inclui uma matriz batchItems que contém uma resposta para cada consulta na solicitação em lote. O batchItems conterá os resultados exatamente na mesma ordem em que as consultas originais foram enviadas na solicitação de lote. Cada item é de um dos seguintes tipos:

  • DirectionsResponse - Se a consulta foi concluída com êxito.

  • Error - Se a consulta falhou. Neste caso, a resposta conterá um code e um message.

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

Parâmetros do URI

Name Em Necessário Tipo Description
api-version
 query True

string

Número da versão da API do Azure Maps.

Cabeçalho do Pedido

Name Necessário Tipo Description
x-ms-client-id

string

Indica a conta destinada a ser usada com o modelo de segurança Microsoft Entra ID. Essa ID exclusiva para a conta do Azure Maps pode ser obtida na API de Conta do plano de gerenciamento do Azure Maps. Para obter mais informações sobre como usar a segurança do Microsoft Entra ID no Azure Maps, consulte Gerenciar autenticação no Azure Maps.
Accept-Language

string

Idioma em que os resultados de roteamento devem ser retornados.

Para obter mais informações, consulte Suporte de localização no Azure Maps.

Corpo do Pedido

Name Tipo Description
batchItems

DirectionsBatchRequestItem[]

A lista de consultas a processar.

Respostas

Name Tipo Description
200 OK

DirectionsBatchResponse

Pedido de lote processado com sucesso. O corpo da resposta contém todos os resultados do lote.
Other Status Codes

MapsErrorResponse

Ocorreu um erro inesperado.

Cabeçalhos

x-ms-error-code: string

Segurança

AADToken

Estes são os Microsoft Entra OAuth 2.0 Flows. Quando emparelhado com controle de de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso às APIs REST do Azure Maps. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais contas de recursos ou subrecursos do Azure Maps. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para APIs REST do Azure Maps.

Para implementar cenários, recomendamos a visualização conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos(s) por meio de objetos capazes de controle de acesso em APIs e escopos específicos.

Note

  • Essa definição de segurança requer o uso do cabeçalho x-ms-client-id para indicar a qual recurso do Azure Maps o aplicativo está solicitando acesso. Isso pode ser adquirido na API de gerenciamento do Maps.
  • O Authorization URL é específico para a instância de nuvem pública do Azure. As nuvens soberanas têm URLs de autorização exclusivas e configurações de ID do Microsoft Entra.
  • O controle de acesso baseado em função do Azure é configurado a partir do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
  • O uso do SDK da Web do Azure Maps permite a configuração baseada em configuração de um aplicativo para vários casos de uso.
  • Para obter mais informações sobre a plataforma de identidade da Microsoft, consulte visão geral da plataforma de identidade da Microsoft.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

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

subscription-key

Essa é uma chave compartilhada que é provisionada ao criar um de recursos do Azure Maps por meio do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com essa chave, qualquer aplicativo está autorizado a acessar todas as APIs REST. Por outras palavras, estas podem atualmente ser tratadas como chaves mestras para a conta para a qual foram emitidas.

Para aplicativos expostos publicamente, nossa recomendação é usar o acesso de servidor para servidor das APIs REST do Azure Maps onde essa chave pode ser armazenada com segurança.

Tipo: apiKey
Em: header

SAS Token

Este é um token de assinatura de acesso compartilhado criado a partir da operação Listar SAS no de recursos do Azure Maps por meio do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com esse token, qualquer aplicativo é autorizado a acessar com controles de acesso baseados em função do Azure e controle de grão fino para a expiração, taxa e região(ões) de uso para o token específico. Em outras palavras, o Token SAS pode ser usado para permitir que os aplicativos controlem o acesso de forma mais segura do que a chave compartilhada.

Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no de recursos da conta do Map para limitar o abuso de renderização e renovar regularmente o Token SAS.

Tipo: apiKey
Em: header

Exemplos

A Route Directions Batch request containing 2 queries

Pedido de amostra

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

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

Resposta da amostra

Código de estado:
200 
{
  "batchItems": [
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "type": "MultiLineString",
            "coordinates": []
          },
          "properties": {
            "distanceInMeters": 2301,
            "durationInSeconds": 514,
            "departureAt": "2025-06-23T01:31:05+00:00",
            "arrivalAt": "2025-06-23T01:40:42+00:00",
            "durationTrafficInSeconds": 577,
            "trafficCongestion": "Mild",
            "type": "RoutePath",
            "legs": []
          }
        }
      ],
      "alternativeRoutes": [
        {
          "type": "FeatureCollection",
          "features": [
            {
              "type": "Feature",
              "geometry": {
                "type": "MultiLineString",
                "coordinates": []
              },
              "properties": {
                "distanceInMeters": 2297,
                "durationInSeconds": 586,
                "departureAt": "2025-06-23T01:31:05+00:00",
                "arrivalAt": "2025-06-23T01:42:27+00:00",
                "durationTrafficInSeconds": 682,
                "trafficCongestion": "Mild",
                "type": "RoutePath",
                "legs": []
              }
            }
          ]
        },
        {
          "type": "FeatureCollection",
          "features": [
            {
              "type": "Feature",
              "geometry": {
                "type": "MultiLineString",
                "coordinates": []
              },
              "properties": {
                "distanceInMeters": 4253,
                "durationInSeconds": 621,
                "departureAt": "2025-06-23T01:31:05+00:00",
                "arrivalAt": "2025-06-23T01:43:39+00:00",
                "durationTrafficInSeconds": 754,
                "trafficCongestion": "Medium",
                "type": "RoutePath",
                "legs": []
              }
            }
          ]
        }
      ]
    },
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "type": "MultiLineString",
            "coordinates": []
          },
          "properties": {
            "distanceInMeters": 2301,
            "durationInSeconds": 514,
            "departureAt": "2025-06-23T01:31:05+00:00",
            "arrivalAt": "2025-06-23T01:40:42+00:00",
            "durationTrafficInSeconds": 577,
            "trafficCongestion": "Mild",
            "type": "RoutePath",
            "legs": []
          }
        }
      ],
      "alternativeRoutes": [
        {
          "type": "FeatureCollection",
          "features": [
            {
              "type": "Feature",
              "geometry": {
                "type": "MultiLineString",
                "coordinates": []
              },
              "properties": {
                "distanceInMeters": 2297,
                "durationInSeconds": 586,
                "departureAt": "2025-06-23T01:31:05+00:00",
                "arrivalAt": "2025-06-23T01:42:27+00:00",
                "durationTrafficInSeconds": 682,
                "trafficCongestion": "Mild",
                "type": "RoutePath",
                "legs": []
              }
            }
          ]
        },
        {
          "type": "FeatureCollection",
          "features": [
            {
              "type": "Feature",
              "geometry": {
                "type": "MultiLineString",
                "coordinates": []
              },
              "properties": {
                "distanceInMeters": 4253,
                "durationInSeconds": 621,
                "departureAt": "2025-06-23T01:31:05+00:00",
                "arrivalAt": "2025-06-23T01:43:39+00:00",
                "durationTrafficInSeconds": 754,
                "trafficCongestion": "Medium",
                "type": "RoutePath",
                "legs": []
              }
            }
          ]
        }
      ]
    }
  ],
  "summary": {
    "successfulRequests": 2,
    "totalRequests": 2
  }
}

Definições

Name Description
Address

O distrito administrativo e a região do país para os pontos de passagem e pontos de manobra na rota.
AdminDistrict

O nome da subdivisão no país ou região de um endereço. Este elemento é normalmente tratado como a subdivisão administrativa de primeira ordem, mas em alguns casos também contém a subdivisão de segunda, terceira ou quarta ordem em um país, dependência ou região.
AdrTunnelRestrictionCodeEnum

O código de restrição do túnel ADR. O ADR é um acordo europeu relativo ao transporte rodoviário internacional de mercadorias perigosas. O código de restrição do túnel ADR é utilizado para determinar se um veículo pode atravessar um túnel com restrições ao transporte de mercadorias perigosas.
AvoidEnum

Especifica as restrições que o cálculo de rota deve respeitar ao determinar a rota. Avoid suporta vários valores em uma solicitação e só é suportado para o modo de condução e viagem do caminhão.

Exemplo: "evitar": ["limitedAccessHighways", "tollRoads"]
CountryRegion

Representa um país ou região, contendo detalhes relacionados.
DirectionsBatchRequestBody

A lista de direções consultas/solicitações a processar. A lista pode conter um máximo de 100 consultas e deve conter pelo menos 1 consulta.
DirectionsBatchRequestItem

Objeto Batch Query
DirectionsBatchResponse

Este objeto é retornado de uma chamada de serviço Directions Batch bem-sucedida.
DirectionsBatchResponseItem

Item de resposta em lote
DrivingSideEnum

Indica a condução à esquerda vs. à direita no ponto da manobra.
ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.
ErrorDetail

O detalhe do erro.
FeatureCollection

GeoJSON FeatureCollection objeto que contém uma lista de recursos. Para obter mais informações, consulte RFC 7946, seção 3.3.
FeaturesItem

Objeto de recurso GeoJSON que contém o objeto Geometry e propriedades adicionais da rota.
FeaturesItemTypeEnum

Especifica o tipo de GeoJSON. O único tipo de objeto suportado é Feature. Para obter mais informações, consulte RFC 7946.
FeatureTypeEnum

Especifica o tipo de GeoJSON. O único tipo de objeto suportado é FeatureCollection. Para obter mais informações, consulte RFC 7946.
GeoJsonPoint

Um tipo de geometria GeoJSON Point válido. Consulte RFC 7946 para obter detalhes.
InputWaypointFeaturesItem

Especifica o waypoint de entrada e viaWaypoint GeoJSON objeto de recurso e propriedades adicionais. Para obter mais informações, consulte RFC 7946.
InputWaypointProperties

Especifica as propriedades de um waypoint que é um local ou ponto específico ao longo de uma rota ou viagem que serve como referência ou ponto de parada.
InputWaypointTypeEnum

Tipo de ponto de passagem na rota. Pode ser uma parada ou um local intermediário pelo qual a rota deve passar.
Instruction

Uma descrição de uma manobra em um conjunto de direções.
Leg

Informações sobre um troço de um percurso entre dois pontos de passagem. Mais informações sobre os campos contidos em um trecho de rota:
ManeuverPointProperties

Especifica as instruções de condução e as propriedades adicionais para cada ponto de manobra na perna do percurso.
ManeuverTypeEnum

O tipo de manobra descrita nesta coleção detalhada. O ManeuverType fornece informações para uma parte da manobra especificada pela instrução correspondente. Por exemplo, o maneuverType de uma instrução pode especificar TurnLeftThenTurnRight, enquanto os itens de detalhes associados podem fornecer detalhes sobre as manobras TurnLeft e TurnRight
MapsErrorDetail

O detalhe do erro.
MapsErrorResponse

Resposta de erro comum para APIs do Azure Maps para retornar detalhes de erro para operações com falha.
MapsInnerError

Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
MultiLineStringGeometry

Especifica o objeto GeoJSON MultiLineString Geometry . Para obter mais informações, consulte RFC 7946.
OptimizedWaypoint

Objeto de ponto de caminho otimizado.
Order

Sequência para visitar waypoints.
PointGeometry

O ponto de origem passou como um objeto GeoJSON Geometry válido, a partir do qual o polígono de intervalo deve ser calculado. Consulte RFC 7946 para obter detalhes.

Note: A API encaixará o ponto de origem solicitado na rede rodoviária mais próxima e o usará para o cálculo do alcance. Ele será retornado como um ponto center na resposta.
RouteDirectionOptimizeRouteEnum

Especifica o parâmetro a ser usado para otimizar a rota. Se não estiver definido, o padrão é "fastestWithoutTraffic", que retorna a rota para minimizar o tempo de viagem sem usar as informações de tráfego atuais.

Exemplo: "optimizeRoute":"shortest"
RouteDirectionVehicleSpec

Especifica os atributos do veículo, como tamanho, peso, velocidade máxima, tipo de carga, etc., apenas para o encaminhamento de caminhões. Isso ajuda a evitar baixas folgas de pontes, restrições de estrada, curvas difíceis à direita para fornecer a rota otimizada do caminhão com base nas especificações do veículo.

ÉNote: Apenas suportado para trucktravelMode.
RouteOutputOptionEnum

Inclua as informações de rota desejadas da resposta. Por padrão, o itinerário é incluído na resposta.

Suporta vários valores como "routeOutputOptions": ["routePath", "itinerary"]
RoutePathPoint

Refere-se ao índice de um ponto dentro de uma etapa específica de uma rota.
RoutePathProperties

Especifica as propriedades que descrevem o caminho da rota na resposta.
RoutePathRange

Refere-se ao intervalo coberto por uma etapa específica de uma rota ou caminho.
RoutePathTravelModeEnum

O modo de viagem para o caminho da rota na resposta.
SideOfStreetEnum

O lado da rua onde o destino é encontrado com base na direção de chegada. Este campo aplica-se apenas ao último maneuverPoint.
Step

Uma etapa de rota contém instruções passo a passo. Um degrau refere-se a um intervalo de uma rota entre dois pontos de manobra consecutivos.
Summary

Resumo do pedido de lote
TrafficCongestionEnum

O nível de congestionamento do tráfego ao longo do percurso. Note: Apenas suportado para condução travelMode
TravelModeEnum

O modo de viagem para a rota solicitada. Se não estiver definido, o valor padrão é "condução" que retorna a rota otimizada para carros.

Note: Para o caminhão travelMode, a rota de caminhão solicitada pode não estar disponível para todo o percurso. Quando a rota do caminhão não estiver disponível para uma seção específica, o elemento travelMode da resposta para essa seção será "outro".

Exemplo: "travelMode":"driving"
VehicleLoadTypeEnum

Tipos de carga que podem ser classificados como materiais perigosos e restringidos a partir de algumas estradas. Os valores disponíveis de vehicleLoadType são as classes 1 a 9 do Hazmat dos EUA, além de classificações genéricas para uso em outros países. Os valores que começam com USHazmat são para roteamento dos EUA, enquanto otherHazmat deve ser usado para todos os outros países. vehicleLoadType suporta vários valores em uma solicitação.
WaypointProperties

Especifica as propriedades de um waypoint que é um local ou ponto específico ao longo de uma rota ou viagem que serve como referência ou ponto de parada.

Address

Object

O distrito administrativo e a região do país para os pontos de passagem e pontos de manobra na rota.

Name Tipo Description
adminDistricts

AdminDistrict[]

O nome da subdivisão no país ou região de um endereço. Este elemento é normalmente tratado como a subdivisão administrativa de primeira ordem, mas em alguns casos também contém a subdivisão de segunda, terceira ou quarta ordem em um país, dependência ou região.
countryRegion

CountryRegion

Representa um país ou região, contendo detalhes relacionados.

AdminDistrict

Object

O nome da subdivisão no país ou região de um endereço. Este elemento é normalmente tratado como a subdivisão administrativa de primeira ordem, mas em alguns casos também contém a subdivisão de segunda, terceira ou quarta ordem em um país, dependência ou região.

Name Tipo Description
shortName

string

O nome abreviado para o campo adminDistrict correspondente, Para adminDistrict[0], pode ser um nome curto de estado, como WA. Isso só está disponível para os EUA, Canadá e México.

AdrTunnelRestrictionCodeEnum

Enumeração

O código de restrição do túnel ADR. O ADR é um acordo europeu relativo ao transporte rodoviário internacional de mercadorias perigosas. O código de restrição do túnel ADR é utilizado para determinar se um veículo pode atravessar um túnel com restrições ao transporte de mercadorias perigosas.

Valor Description
B

Os veículos com o código B estão sujeitos a restrições nas estradas com túnel ADR das categorias B, C, D e E.
C

Os veículos com o código C são restringidos nas estradas com túnel ADR das categorias C, D e E
D

Os veículos com o código D são proibidos de circular nas estradas com túnel ADR das categorias D e E.
E

Os veículos com o código E são proibidos de circular nas estradas com túnel ADR da categoria E.

AvoidEnum

Enumeração

Especifica as restrições que o cálculo de rota deve respeitar ao determinar a rota. Avoid suporta vários valores em uma solicitação e só é suportado para o modo de condução e viagem do caminhão.

Exemplo: "evitar": ["limitedAccessHighways", "tollRoads"]

Valor Description
limitedAccessHighways

Evita o uso de rodovias de acesso limitado na rota.
tollRoads

Evita o uso de estradas com portagem no percurso.
ferries

Evita o uso de balsas na rota.
tunnels

Evita o uso de túneis no percurso.
borderCrossings

Evita atravessar as fronteiras do país na rota.
lowEmissionZones

Evita zonas de baixas emissões na rota.
unpavedRoads

Evita estradas não pavimentadas no percurso.

CountryRegion

Object

Representa um país ou região, contendo detalhes relacionados.

Name Tipo Description
ISO

string

A ISO do país/região representa um código de região/país ISO 3166-1 Alpha-2
name

string

nome do país/região

DirectionsBatchRequestBody

Object

A lista de direções consultas/solicitações a processar. A lista pode conter um máximo de 100 consultas e deve conter pelo menos 1 consulta.

Name Tipo Description
batchItems

DirectionsBatchRequestItem[]

A lista de consultas a processar.

DirectionsBatchRequestItem

Object

Objeto Batch Query

Name Tipo Default value Description
arriveAt

string (date-time)

A data e hora de chegada ao ponto de destino formatado como um valor de dateTime definido pelo RFC 3339, seção 5.6. Quando um deslocamento de fuso horário não é especificado, UTC será assumido.

O parâmetro arriveAt não pode ser usado em conjunto com departAt.

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

AvoidEnum[]

Especifica as restrições que o cálculo de rota deve respeitar ao determinar a rota. Avoid suporta vários valores em uma solicitação e só é suportado para o modo de condução e viagem do caminhão.

Exemplo: "evitar": ["limitedAccessHighways", "tollRoads"]
departAt

string (date-time)

A data e hora de partida do ponto de origem formatado como um valor de dateTime definido pelo RFC 3339, seção 5.6. Quando um deslocamento de fuso horário não é especificado, UTC será assumido.

Se o departAt não estiver definido, o valor padrão será a hora atual.

Example:

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

InputWaypointFeaturesItem[]

As rotas de condução, caminhada e caminhão são definidas por um conjunto de waypoints (paradas) e viaWaypoints (locais intermediários pelos quais a rota deve passar). Você pode ter um máximo de 150 waypoints, e um máximo de 10 viaWaypoints entre cada conjunto de waypoints.

Uma rota deve ter um mínimo de 2 waypoints e os pontos de início e fim da rota não podem ser via Waypoints.

Os locais waypoint e viaWaypoint devem ser especificados como um objeto de recurso GeoJSON Point válido, juntamente com pointIndex que especifica a ordem dos locais. Para obter mais informações sobre o formato GeoJSON, consulte RFC 7946.
heading

integer (int64)

minimum: 0
maximum: 359

A direção direcional inicial do veículo, em graus, começando no norte verdadeiro e continuando no sentido horário. Norte é de 0 graus, leste é de 90 graus, sul é de 180 graus, oeste é de 270 graus.
maxRouteCount

integer (int64)

minimum: 1
maximum: 6

O número máximo de rotas a retornar. Disponível para os modos de condução e de viagem de camião.

Padrão: "maxRouteCount":1
optimizeRoute

RouteDirectionOptimizeRouteEnum

fastestWithoutTraffic

Especifica o parâmetro a ser usado para otimizar a rota. Se não estiver definido, o padrão é "fastestWithoutTraffic", que retorna a rota para minimizar o tempo de viagem sem usar as informações de tráfego atuais.

Exemplo: "optimizeRoute":"shortest"
optimizeWaypointOrder

boolean

False

Reordene os waypoints de rota usando um algoritmo heurístico rápido para reduzir o custo de rota especificado com o parâmetro optimiz. A origem e o destino são excluídos do waypoint otimizado e sua posição é considerada fixa. Os valores aceitáveis são true ou false.
optionalId

string

Id da solicitação que seria exibida no lote correspondente.
routeOutputOptions

RouteOutputOptionEnum[]

[ "itinerary" ]

Inclua as informações de rota desejadas da resposta. Por padrão, o itinerário é incluído na resposta.

Suporta vários valores como "routeOutputOptions": ["routePath", "itinerary"]
travelMode

TravelModeEnum

driving

O modo de viagem para a rota solicitada. Se não estiver definido, o valor padrão é "condução" que retorna a rota otimizada para carros.

Note: Para o caminhão travelMode, a rota de caminhão solicitada pode não estar disponível para todo o percurso. Quando a rota do caminhão não estiver disponível para uma seção específica, o elemento travelMode da resposta para essa seção será "outro".

Exemplo: "travelMode":"driving"
type

FeatureTypeEnum

Especifica o tipo de GeoJSON. O único tipo de objeto suportado é FeatureCollection. Para obter mais informações, consulte RFC 7946.
vehicleSpec

RouteDirectionVehicleSpec

Especifica os atributos do veículo, como tamanho, peso, velocidade máxima, tipo de carga, etc., apenas para o encaminhamento de caminhões. Isso ajuda a evitar baixas folgas de pontes, restrições de estrada, curvas difíceis à direita para fornecer a rota otimizada do caminhão com base nas especificações do veículo.

Note: Apenas suportado para truck travelMode

DirectionsBatchResponse

Object

Este objeto é retornado de uma chamada de serviço Directions Batch bem-sucedida.

Name Tipo Description
batchItems

DirectionsBatchResponseItem[]

Matriz que contém os resultados do lote.
summary

Summary

Resumo do pedido de lote

DirectionsBatchResponseItem

Object

Item de resposta em lote

Name Tipo Description
alternativeRoutes

FeatureCollection[]

Rota alternativa.
error

ErrorDetail

O detalhe do erro.
features

FeaturesItem[]

GeoJSON objeto de recurso que contém o objeto Geometry e propriedades adicionais. Para obter mais informações, consulte RFC 7946, Seção 3.2.
optionalId

string

Id da solicitação que seria exibida no lote correspondente.
type

FeatureTypeEnum

Especifica o tipo de GeoJSON. O único tipo de objeto suportado é FeatureCollection. Para obter mais informações, consulte RFC 7946.

DrivingSideEnum

Enumeração

Indica a condução à esquerda vs. à direita no ponto da manobra.

Valor Description
Left

Condução à esquerda.
Right

Condução à direita.

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.
code

string

O código de erro.
details

ErrorDetail[]

Os detalhes do erro.
message

string

A mensagem de erro.
target

string

O destino do erro.

FeatureCollection

Object

GeoJSON FeatureCollection objeto que contém uma lista de recursos. Para obter mais informações, consulte RFC 7946, seção 3.3.

Name Tipo Description
features

FeaturesItem[]

GeoJSON objeto de recurso que contém o objeto Geometry e propriedades adicionais. Para obter mais informações, consulte RFC 7946, Seção 3.2.
type

FeatureTypeEnum

Especifica o tipo de GeoJSON. O único tipo de objeto suportado é FeatureCollection. Para obter mais informações, consulte RFC 7946.

FeaturesItem

Object

Objeto de recurso GeoJSON que contém o objeto Geometry e propriedades adicionais da rota.

Name Tipo Description
bbox

number[] (double)

Uma área retangular na Terra definida como um objeto de caixa delimitadora. Os lados dos retângulos são definidos por valores de latitude e longitude. Para obter mais informações, consulte RFC 7946, Seção 5.

Exemplo: "bbox": [-10.0, -10.0, 10.0, 10.0]
geometry RouteDirectionsGeometry:

Um objeto GeoJSON Geometry válido. Para obter mais informações, consulte RFC 7946.
properties FeatureProperties:

Especifica as propriedades de recurso da rota, como itinerário, percurso, pernas e geometria, resumo da viagem.
type

FeaturesItemTypeEnum

Especifica o tipo de GeoJSON. O único tipo de objeto suportado é Feature. Para obter mais informações, consulte RFC 7946.

FeaturesItemTypeEnum

Enumeração

Especifica o tipo de GeoJSON. O único tipo de objeto suportado é Feature. Para obter mais informações, consulte RFC 7946.

Valor Description
Feature

Especifica o tipo de objeto GeoJSON Feature.

FeatureTypeEnum

Enumeração

Especifica o tipo de GeoJSON. O único tipo de objeto suportado é FeatureCollection. Para obter mais informações, consulte RFC 7946.

Valor Description
FeatureCollection

Especifica o tipo de objeto GeoJSONFeatureCollection.

GeoJsonPoint

Object

Um tipo de geometria GeoJSON Point válido. Consulte RFC 7946 para obter detalhes.

Name Tipo Description
coordinates

number[] (double)

Um Position é uma matriz de números com dois ou mais elementos. Os dois primeiros elementos são longitude e latitude, precisamente nesta ordem. de Altitude/Elevação é um terceiro elemento opcional. Consulte RFC 7946 para obter detalhes.
type string:

Point

Especifica o tipo de GeoJSON. Deve ser um dos nove tipos de objeto GeoJSON válidos - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

InputWaypointFeaturesItem

Object

Especifica o waypoint de entrada e viaWaypoint GeoJSON objeto de recurso e propriedades adicionais. Para obter mais informações, consulte RFC 7946.

Name Tipo Description
geometry GeoJsonPoint:

PointGeometry

Um tipo de geometria GeoJSON Point válido. Consulte RFC 7946 para obter detalhes.
properties

InputWaypointProperties

Especifica as propriedades de um waypoint que é um local ou ponto específico ao longo de uma rota ou viagem que serve como referência ou ponto de parada.
type

FeaturesItemTypeEnum

Especifica o tipo de GeoJSON. O único tipo de objeto suportado é Feature. Para obter mais informações, consulte RFC 7946.

InputWaypointProperties

Object

Especifica as propriedades de um waypoint que é um local ou ponto específico ao longo de uma rota ou viagem que serve como referência ou ponto de parada.

Name Tipo Default value Description
pointIndex

integer (int64)

Identifique e ordene a sequência de pontos de passagem na rota. O valor padrão é o index value de uma matriz de recursos.
pointType

InputWaypointTypeEnum

waypoint

Tipo de ponto de passagem na rota. Pode ser uma parada ou um local intermediário pelo qual a rota deve passar.

InputWaypointTypeEnum

Enumeração

Tipo de ponto de passagem na rota. Pode ser uma parada ou um local intermediário pelo qual a rota deve passar.

Valor Description
waypoint

Um waypoint é um local ou ponto específico ao longo de uma rota ou viagem que serve como referência ou ponto de parada.
viaWaypoint

Um viaWaypoint é um waypoint específico que deve ser passado ou visitado ao longo de uma rota ou viagem.

Instruction

Object

Uma descrição de uma manobra em um conjunto de direções.

Name Tipo Description
drivingSide

DrivingSideEnum

Indica a condução à esquerda vs. à direita no ponto da manobra.
formattedText

string

A descrição do texto formatado da instrução.
maneuverType

ManeuverTypeEnum

O tipo de manobra descrita nesta coleção detalhada. O ManeuverType fornece informações para uma parte da manobra especificada pela instrução correspondente. Por exemplo, o maneuverType de uma instrução pode especificar TurnLeftThenTurnRight, enquanto os itens de detalhes associados podem fornecer detalhes sobre as manobras TurnLeft e TurnRight
text

string

A descrição em texto simples da instrução.

Leg

Object

Informações sobre um troço de um percurso entre dois pontos de passagem. Mais informações sobre os campos contidos em um trecho de rota:

Name Tipo Description
arrivalAt

string (date-time)

A hora de chegada estimada para o trecho, que leva em conta as condições de tráfego, é formatada como um valor dateTime definido pelo RFC 3339, seção 5.6. Ele fará referência ao deslocamento de fuso horário por departAt ou arrivalAt. Caso contrário, será utilizada a hora UTC.
departureAt

string (date-time)

A hora de partida estimada para o trecho, que leva em conta as condições de tráfego, é formatada como um valor dateTime definido pelo RFC 3339, seção 5.6. Ele fará referência ao deslocamento de fuso horário por departAt ou arrivalAt. Caso contrário, será utilizada a hora UTC.
distanceInMeters

number

A distância física em metros percorrida por uma rota Leg.
durationInSeconds

integer (int64)

Tempo de viagem estimado em segundos que não inclui atrasos na rota devido às condições de tráfego.
durationTrafficInSeconds

integer (int64)

O tempo que demora, em segundos, a percorrer um TravelDistance correspondente às condições de tráfego atuais. Esse valor é fornecido se optimizeRoute incluir considerações de tráfego.
routePathRange

RoutePathRange

Refere-se ao intervalo coberto por uma etapa específica de uma rota ou caminho.

ManeuverPointProperties

Object

Especifica as instruções de condução e as propriedades adicionais para cada ponto de manobra na perna do percurso.

Name Tipo Default value Description
address

Address

O distrito administrativo e a região do país para os pontos de passagem e pontos de manobra na rota.
distanceInMeters

number

A distância física em metros percorridos por este percurso degrau.
durationInSeconds

integer (int64)

O tempo que demora, em segundos, a percorrer um TravelDistancecorrespondente.
exitIdentifier

string

O nome ou número da saída associada a esta etapa de rota.
instruction

Instruction

Uma descrição de uma manobra em um conjunto de direções.
order

Order

Sequência para visitar waypoints.
routePathPoint

RoutePathPoint

Refere-se ao índice de um ponto dentro de uma etapa específica de uma rota.
sideOfStreet

SideOfStreetEnum

O lado da rua onde o destino é encontrado com base na direção de chegada. Este campo aplica-se apenas ao último maneuverPoint.
signs

string[]

Texto de sinalização para a rota. Pode haver mais de um valor de sinal.
steps

Step[]

Passos entre dois pontos de manobra consecutivos.
towardsRoadName

string

O nome da rua para a qual o percurso vai no primeiro ManeuverPoint.
travelMode

RoutePathTravelModeEnum

driving

O modo de viagem para o caminho da rota na resposta.
type string:

ManeuverPoint

Tipo de saída.

ManeuverTypeEnum

Enumeração

O tipo de manobra descrita nesta coleção detalhada. O ManeuverType fornece informações para uma parte da manobra especificada pela instrução correspondente. Por exemplo, o maneuverType de uma instrução pode especificar TurnLeftThenTurnRight, enquanto os itens de detalhes associados podem fornecer detalhes sobre as manobras TurnLeft e TurnRight

Valor Description
ArriveFinish

Chegue ao destino final.
ArriveIntermediate

Chegue a um ponto de passagem intermediário.
BearLeft

Urso à esquerda.
BearLeftThenBearLeft

Urso à esquerda e depois urso à esquerda novamente.
BearLeftThenBearRight

Leve para a esquerda e depois para a direita.
BearLeftThenTurnLeft

Mantenha-se à esquerda e vire à esquerda.
BearLeftThenTurnRight

Mantenha-se à esquerda e vire à direita.
BearRight

Ter razão.
BearRightThenBearLeft

Leve para a direita e depois para a esquerda.
BearRightThenBearRight

Ter direito e depois ter direito novamente.
BearRightThenTurnLeft

Mantenha-se à direita e vire à esquerda.
BearRightThenTurnRight

Mantenha-se à direita e vire à direita.
BearThenKeep

Instrução de urso e, em seguida, uma instrução de manutenção
BearThenMerge

Instrução de urso e, em seguida, uma instrução de mesclagem.
Continue

Continue na estrada atual.
DepartIntermediateStop

Deixe um ponto de passagem intermediário em uma direção e estrada diferentes do que você chegou.
DepartIntermediateStopReturning

Deixe um ponto de passagem intermediário na mesma direção e na mesma estrada em que você chegou.
DepartStart

Deixe o ponto de partida.
EnterRoundabout

Entre numa rotunda.
ExitRoundabout

Saia de uma rotatória.
EnterThenExitRoundabout

Entre e saia de uma rotatória.
ExitRoundaboutRight

Na rotatória, pegue a saída à direita.
ExitRoundaboutLeft

Na rotatória, pegue a saída à esquerda.
Follow

Follow.
GoAroundRoundabout

Contorne a rotunda.
KeepLeft

Mantenha-se à esquerda em uma estrada diferente.
KeepOnRampLeft

Mantenha-se à esquerda e continue na rampa.
KeepOnRampRight

Mantenha-se à direita e continue na rampa.
KeepOnRampStraight

Mantenha-se em frente e continue na rampa.
KeepRight

Mantenha-se à direita em uma estrada diferente.
KeepStraight

Siga em frente para uma estrada diferente.
KeepToStayLeft

Mantenha-se à esquerda para permanecer na mesma estrada.
KeepToStayRight

Mantenha-se à direita para permanecer na mesma estrada.
KeepToStayStraight

Mantenha-se em frente para permanecer na mesma estrada.
MergeFreeway

Entre em uma rodovia.
MergeHighway

Entre em uma rodovia.
MergeMotorway

Entre em uma rodovia.
MotorwayExitLeft

Pegue a saída à esquerda.
MotorwayExitRight

Pegue a saída à direita.
None

Nenhuma instrução.
RampThenHighwayLeft

Pegue a rampa à esquerda para a rodovia. Isso faz parte de uma instrução combinada.
RampThenHighwayRight

Pegue a rampa à direita para a rodovia. Isso faz parte de uma instrução combinada.
RampThenHighwayStraight

Mantenha-se em frente para pegar a rampa para a rodovia. Isso faz parte de uma instrução combinada.
RoadNameChange

Mudança de nome da estrada.
SwitchToParallelRoad

Mude para a estrada paralela.
SwitchToMainRoad

Mude para a estrada principal.
Take

Pegue a estrada. Esta instrução é usada quando você está entrando ou saindo de uma balsa.
TakeFerry

Pegue a balsa.
TakeExit

Pegue a saída.
TakeRamp

Pegue a rampa.
TakeRampLeft

Pegue a rampa à esquerda.
TakeRampRight

Pegue a rampa à direita.
TakeRampStraight

Mantenha-se em frente para pegar a rampa.
TurnBack

Volte bruscamente.
TurnLeft

Vire à esquerda.
TurnLeftSharp

Faça uma curva acentuada à esquerda.
TurnLeftThenBearLeft

Vire à esquerda e mantenha-se à esquerda.
TurnLeftThenBearRight

Vire à esquerda e depois mantenha-se à direita.
TurnLeftThenTurnLeft

Vire à esquerda e vire à esquerda novamente.
TurnLeftThenTurnRight

Vire à esquerda e depois à direita.
TurnRight

Vire à direita.
TurnRightSharp

Faça uma curva acentuada à direita.
TurnRightThenBearLeft

Vire à direita e depois mantenha-se à esquerda.
TurnRightThenBearRight

Vire à direita e mantenha-se à direita.
TurnRightThenTurnLeft

Vire à direita e, em seguida, vire à esquerda.
TurnRightThenTurnRight

Vire à direita e depois vire à direita novamente
TurnThenMerge

Instrução de turno seguida por uma instrução de mesclagem.
TurnToStayLeft

Vire à esquerda para permanecer na mesma estrada.
TurnToStayRight

Vire à direita para permanecer na mesma estrada.
Unknown

A instrução é desconhecida.
UTurn

Faça um retorno em U para ir na direção oposta.
Wait

Wait
Walk

Walk

MapsErrorDetail

Object

O detalhe do erro.

Name Tipo Description
code

string

Um de um conjunto de códigos de erro definido pelo servidor.
details

MapsErrorDetail[]

Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror

MapsInnerError

Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message

string

Uma representação legível por humanos do erro.
target

string

O alvo do erro.

MapsErrorResponse

Object

Resposta de erro comum para APIs do Azure Maps para retornar detalhes de erro para operações com falha.

Name Tipo Description
error

MapsErrorDetail

O detalhe do erro.

MapsInnerError

Object

Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.

Name Tipo Description
code

string

O código de erro.
innererror

MapsInnerError

Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.

MultiLineStringGeometry

Object

Especifica o objeto GeoJSON MultiLineString Geometry . Para obter mais informações, consulte RFC 7946.

Name Tipo Description
coordinates

number[] (double)

Coordenadas para a geometria GeoJson MultiLineString.
type string:

MultiLineString

Especifica o tipo de geometria para o objeto GeoJSON Geometry. Para obter mais informações, consulte RFC 7946.

OptimizedWaypoint

Object

Objeto de ponto de caminho otimizado.

Name Tipo Description
inputIndex

integer (int64)

Índice de pontos de passagem fornecido pelo usuário.
optimizedIndex

integer (int64)

Índice de pontos de passagem otimizado do sistema.

Order

Object

Sequência para visitar waypoints.

Name Tipo Description
inputIndex

integer (int64)

Índice fornecido pelo usuário para waypoint
optimizedIndex

integer (int64)

Ponto de passagem otimizado para o sistema

PointGeometry

Object

O ponto de origem passou como um objeto GeoJSON Geometry válido, a partir do qual o polígono de intervalo deve ser calculado. Consulte RFC 7946 para obter detalhes.

Note: A API encaixará o ponto de origem solicitado na rede rodoviária mais próxima e o usará para o cálculo do alcance. Ele será retornado como um ponto center na resposta.

Name Tipo Description
coordinates

number[] (double)

Um Position é uma matriz de números com dois ou mais elementos. Os dois primeiros elementos são longitude e latitude, precisamente nesta ordem. de Altitude/Elevação é um terceiro elemento opcional. Consulte RFC 7946 para obter detalhes.
type string:

Point

Especifica o tipo de geometria para o objeto GeoJSON Geometry. Para obter mais informações, consulte RFC 7946.

RouteDirectionOptimizeRouteEnum

Enumeração

Especifica o parâmetro a ser usado para otimizar a rota. Se não estiver definido, o padrão é "fastestWithoutTraffic", que retorna a rota para minimizar o tempo de viagem sem usar as informações de tráfego atuais.

Exemplo: "optimizeRoute":"shortest"

Valor Description
short

A rota é calculada para equilibrar o tempo de viagem rápido e a curta distância, em vez de priorizar apenas uma. É otimizado para velocidade e eficiência. As informações de tráfego não são utilizadas.
shortest

O percurso é calculado para minimizar a distância. As informações de tráfego não são utilizadas.
fastestWithoutTraffic

Encontra a rota mais rápida, sem levar em conta as informações de trânsito.
fastestWithTraffic

A rota é calculada para minimizar o tempo usando as informações de tráfego atuais. Note: Apenas suportado para condução e camião travelMode.

RouteDirectionVehicleSpec

Object

Especifica os atributos do veículo, como tamanho, peso, velocidade máxima, tipo de carga, etc., apenas para o encaminhamento de caminhões. Isso ajuda a evitar baixas folgas de pontes, restrições de estrada, curvas difíceis à direita para fornecer a rota otimizada do caminhão com base nas especificações do veículo.

ÉNote: Apenas suportado para trucktravelMode.

Name Tipo Default value Description
adrTunnelRestrictionCode

AdrTunnelRestrictionCodeEnum

O código de restrição do túnel ADR. O ADR é um acordo europeu relativo ao transporte rodoviário internacional de mercadorias perigosas. O código de restrição do túnel ADR é utilizado para determinar se um veículo pode atravessar um túnel com restrições ao transporte de mercadorias perigosas.
axleCount

integer (int64)

O número de eixos do veículo.
axleWeight

integer (int64)

minimum: 0
maximum: 1000000 		0

Peso por eixo do veículo, em kg. Um valor 0 significa que as restrições de peso por eixo não são consideradas.
height

number (double)

minimum: 0
maximum: 1000000 		0

Altura do veículo em metros. Um valor 0 significa que as restrições de altura não são consideradas.
isVehicleCommercial

boolean

False

Se o veículo é utilizado para fins comerciais. Os veículos comerciais podem não ser autorizados a circular em algumas estradas.
length

number (double)

minimum: 0
maximum: 1000000 		0

Comprimento do veículo em metros. Um valor de 0 significa que as restrições de comprimento não são consideradas.
loadType

VehicleLoadTypeEnum[]

Tipos de carga que podem ser classificados como materiais perigosos e restringidos a partir de algumas estradas. Os valores disponíveis de vehicleLoadType são as classes 1 a 9 do Hazmat dos EUA, além de classificações genéricas para uso em outros países. Os valores que começam com USHazmat são para roteamento dos EUA, enquanto otherHazmat deve ser usado para todos os outros países. vehicleLoadType suporta vários valores em uma solicitação.
maxSpeed

integer (int64)

minimum: 0
maximum: 250 		0

Velocidade máxima do veículo em km/hora. A velocidade máxima no perfil do veículo é utilizada para verificar se um veículo é permitido em autoestradas.

Um valor 0 significa que será determinado e aplicado um valor adequado para o veículo durante o planeamento de rotas.

Um valor diferente de zero pode ser substituído durante o planejamento de rotas. Por exemplo, o fluxo de tráfego atual é de 60 km/hora. Se a velocidade máxima do veículo estiver definida para 50 km/hora, o motor de encaminhamento considerará 60 km/hora, uma vez que esta é a situação atual. Se a velocidade máxima do veículo for fornecida como 80 km/hora, mas o fluxo de tráfego atual for de 60 km/hora, o motor de roteamento usará novamente 60 km/hora.
weight

integer (int64)

minimum: 0
maximum: 1000000 		0

Peso do veículo em quilogramas. Um valor 0 significa que as restrições de peso não são consideradas.
width

number (double)

minimum: 0
maximum: 1000000 		0

Largura do veículo em metros. Um valor de 0 significa que as restrições de largura não são consideradas.

RouteOutputOptionEnum

Enumeração

Inclua as informações de rota desejadas da resposta. Por padrão, o itinerário é incluído na resposta.

Suporta vários valores como "routeOutputOptions": ["routePath", "itinerary"]

Valor Description
routeSummary

Inclua apenas o tempo de viagem e a distância para a rota e não forneça outras informações.
routePath

Inclua um GeoJSON MultiLineString RFC 7946, seção 3.1.5 que descrevem o caminho da rota na resposta.
itinerary

Inclua instruções detalhadas na resposta. As instruções detalhadas são fornecidas como "Pontos de Manobra" e contêm detalhes como instruções passo a passo.

RoutePathPoint

Object

Refere-se ao índice de um ponto dentro de uma etapa específica de uma rota.

Name Tipo Description
legIndex

integer (int64)

O índice de perna de rota é um número sequencial atribuído a cada trecho da rota para ajudar a identificar e distinguir entre diferentes segmentos da rota.
pointIndex

integer (int64)

Índice de um ponto dentro de uma perna específica.

RoutePathProperties

Object

Especifica as propriedades que descrevem o caminho da rota na resposta.

Name Tipo Description
arrivalAt

string (date-time)

A hora de chegada estimada para o trecho, que leva em conta as condições de tráfego, é formatada como um valor de dateTime definido pelo RFC 3339, seção 5.6. Ele fará referência ao deslocamento de fuso horário por departAt ou arrivalAt. Caso contrário, será utilizada a hora UTC.
departureAt

string (date-time)

O tempo de partida estimado para o trecho, que leva em conta as condições de tráfego, é formatado como um valor de dateTime definido pelo RFC 3339, seção 5.6. Ele fará referência ao deslocamento de fuso horário por departAt ou arrivalAt. Caso contrário, será utilizada a hora UTC.
distanceInMeters

number

A distância física em metros percorrida por todo o percurso.
durationInSeconds

integer (int64)

Tempo de viagem estimado em segundos que não inclui atrasos na rota devido às condições de tráfego.
durationTrafficInSeconds

integer (int64)

O tempo que demora, em segundos, a percorrer um TravelDistance correspondente às condições de tráfego atuais. Esse valor é fornecido se optimizeRoute incluir considerações de tráfego.
legs

Leg[]

Uma variedade de pernas de rota. Verifique a rota Descrição do objeto Perna para obter mais informações.
optimizedWaypoints

OptimizedWaypoint[]

Sequência otimizada de waypoints. Ele mostra o índice da sequência de waypoint fornecida pelo usuário para as listas originais e otimizadas.
trafficCongestion

TrafficCongestionEnum

O nível de congestionamento do tráfego ao longo do percurso. Note: Apenas suportado para condução travelMode
type string:

RoutePath

Tipo de saída.

RoutePathRange

Object

Refere-se ao intervalo coberto por uma etapa específica de uma rota ou caminho.

Name Tipo Description
legIndex

integer (int64)

O índice de perna de rota é um número sequencial atribuído a cada trecho da rota para ajudar a identificar e distinguir entre diferentes segmentos da rota.
range

integer[] (int64)

Refere-se ao intervalo coberto por uma etapa específica de uma rota ou caminho.

RoutePathTravelModeEnum

Enumeração

O modo de viagem para o caminho da rota na resposta.

Valor Description
driving

Rotas otimizadas para carros.
truck

Rotas otimizadas para camiões de grande dimensão com base na especificação do veículo.
walking

Percursos otimizados para peões.
other

RouteTravelMode é retornado como "outro" para o caminhão travelMode quando a rota do caminhão não está disponível para uma seção específica de uma rota.

SideOfStreetEnum

Enumeração

O lado da rua onde o destino é encontrado com base na direção de chegada. Este campo aplica-se apenas ao último maneuverPoint.

Valor Description
Left

Left.
Right

Right.
Unknown

Unknown.

Step

Object

Uma etapa de rota contém instruções passo a passo. Um degrau refere-se a um intervalo de uma rota entre dois pontos de manobra consecutivos.

Name Tipo Description
maneuverType

ManeuverTypeEnum

O tipo de manobra descrita nesta coleção detalhada. O ManeuverType fornece informações para uma parte da manobra especificada pela instrução correspondente. Por exemplo, o maneuverType de uma instrução pode especificar TurnLeftThenTurnRight, enquanto os itens de detalhes associados podem fornecer detalhes sobre as manobras TurnLeft e TurnRight
names

string[]

Uma rua, rodovia ou cruzamento onde ocorre a manobra. Se a manobra for complexa, pode haver mais de um campo de nome na coleção de detalhes. O campo de nome também pode não ter valor. Isso pode ocorrer se o nome não for conhecido ou se uma rua, rodovia ou cruzamento não tiver um nome.
routePathRange

RoutePathRange

Refere-se ao intervalo coberto por uma etapa específica de uma rota ou caminho.

Summary

Object

Resumo do pedido de lote

Name Tipo Description
successfulRequests

integer (int32)

Número de solicitações bem-sucedidas no lote
totalRequests

integer (int32)

Número total de solicitações no lote

TrafficCongestionEnum

Enumeração

O nível de congestionamento do tráfego ao longo do percurso. Note: Apenas suportado para condução travelMode

Valor Description
Unknown

Unknown.
None

None.
Mild

Mild.
Medium

Medium.
Heavy

Heavy.

TravelModeEnum

Enumeração

O modo de viagem para a rota solicitada. Se não estiver definido, o valor padrão é "condução" que retorna a rota otimizada para carros.

Note: Para o caminhão travelMode, a rota de caminhão solicitada pode não estar disponível para todo o percurso. Quando a rota do caminhão não estiver disponível para uma seção específica, o elemento travelMode da resposta para essa seção será "outro".

Exemplo: "travelMode":"driving"

Valor Description
driving

As rotas devolvidas são otimizadas para carros.
truck

As rotas devolvidas são otimizadas para caminhões de grande porte com base na especificação do veículo.
walking

As rotas de retorno são otimizadas para pedestres, incluindo o uso de calçadas.

VehicleLoadTypeEnum

Enumeração

Tipos de carga que podem ser classificados como materiais perigosos e restringidos a partir de algumas estradas. Os valores disponíveis de vehicleLoadType são as classes 1 a 9 do Hazmat dos EUA, além de classificações genéricas para uso em outros países. Os valores que começam com USHazmat são para roteamento dos EUA, enquanto otherHazmat deve ser usado para todos os outros países. vehicleLoadType suporta vários valores em uma solicitação.

Valor Description
USHazmatClass1

Explosives
USHazmatClass2

Gás comprimido
USHazmatClass3

Líquidos inflamáveis
USHazmatClass4

Sólidos inflamáveis
USHazmatClass5

Oxidizers
USHazmatClass6

Poisons
USHazmatClass7

Radioactive
USHazmatClass8

Corrosives
USHazmatClass9

Miscellaneous
otherHazmatExplosive

Explosives
otherHazmatGeneral

Miscellaneous
otherHazmatHarmfulToWater

Nocivo para a água

WaypointProperties

Object

Especifica as propriedades de um waypoint que é um local ou ponto específico ao longo de uma rota ou viagem que serve como referência ou ponto de parada.

Name Tipo Default value Description
address

Address

O distrito administrativo e a região do país para os pontos de passagem e pontos de manobra na rota.
distanceInMeters

number

A distância física em metros percorridos por este percurso degrau.
durationInSeconds

integer (int64)

O tempo que demora, em segundos, a percorrer um TravelDistancecorrespondente.
exitIdentifier

string

O nome ou número da saída associada a esta etapa de rota.
instruction

Instruction

Uma descrição de uma manobra em um conjunto de direções.
order

Order

Sequência para visitar waypoints.
routePathPoint

RoutePathPoint

Refere-se ao índice de um ponto dentro de uma etapa específica de uma rota.
sideOfStreet

SideOfStreetEnum

O lado da rua onde o destino é encontrado com base na direção de chegada. Este campo aplica-se apenas ao último maneuverPoint.
signs

string[]

Texto de sinalização para a rota. Pode haver mais de um valor de sinal.
steps

Step[]

Passos entre dois pontos de manobra consecutivos.
towardsRoadName

string

O nome da rua para a qual o percurso vai no primeiro ManeuverPoint.
travelMode

RoutePathTravelModeEnum

driving

O modo de viagem para o caminho da rota na resposta.
type string:

Waypoint

Tipo de saída.