Route - Post Route Directions Batch

Referência

Serviço:: Maps

Versão da API:: 2025-01-01

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

A API de é uma solicitação HTTP que envia lotes de até 100 consultas em uma única chamada para a API de Rotas .

Enviar solicitação de lote síncrona

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

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

Corpo POST para solicitação em lote

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

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

Uma direções objeto batchItem pode aceitar qualquer uma das instruções de com suportecorpo 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 o totalRequests que faziam parte da solicitação em lote original e successfulRequests consultas que foram executadas com êxito. A resposta em lote também inclui uma matriz de 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 em lote. Cada item é de um dos seguintes tipos:

DirectionsResponse - Se a consulta foi concluída com êxito.
Error - Se a consulta falhou. A resposta conterá um code e um message nesse caso.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
api-version	query	True	string	Número de versão da API do Azure Mapas.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-id		string	Especifica qual conta destina-se ao uso em conjunto com o modelo de segurança da ID do Microsoft Entra. Ele representa uma ID exclusiva para a conta do Azure Mapas e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Mapas. Para usar a segurança da ID do Microsoft Entra no Azure Mapas, consulte os artigos de a seguir para obter diretrizes.
Accept-Language		string	Idioma no qual os resultados do roteamento devem ser retornados. Para obter mais informações, consulte Suporte à Localização no Azure Mapas.

Nome

Obrigatório

Tipo

Description

x-ms-client-id

string

Especifica qual conta destina-se ao uso em conjunto com o modelo de segurança da ID do Microsoft Entra. Ele representa uma ID exclusiva para a conta do Azure Mapas e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Mapas. Para usar a segurança da ID do Microsoft Entra no Azure Mapas, consulte os artigos de a seguir para obter diretrizes.

Accept-Language

string

Idioma no qual os resultados do roteamento devem ser retornados.

Para obter mais informações, consulte Suporte à Localização no Azure Mapas.

Corpo da solicitação

Nome	Tipo	Description
batchItems	DirectionsBatchRequestItem[]	A lista de consultas a serem processadas.

Respostas

Nome	Tipo	Description
200 OK	DirectionsBatchResponse	Solicitação em lote processada com êxito. 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

Nome

Tipo

Description

200 OK

DirectionsBatchResponse

Solicitação em lote processada com êxito. 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

Estas são as Fluxos de do Microsoft Entra OAuth 2.0. Quando emparelhado com acesso baseado em função do Azure controle, ele pode ser usado para controlar o acesso às APIs REST do Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais sub-recursos ou conta de recurso do Azure Mapas. 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 Mapas.

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

Observação

Essa definição de segurança requer o uso do cabeçalho x-ms-client-id para indicar a qual recurso do Azure Mapas o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento do Mapas.
O Authorization URL é específico para a instância de nuvem pública do Azure. 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 do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.
O uso do SDK da Web do do Azure Mapas 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
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

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

subscription-key

Essa é uma chave compartilhada provisionada ao criar um recurso do Azure Mapas por meio do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.

Com essa chave, qualquer aplicativo está autorizado a acessar todas as APIs REST. Em outras palavras, elas podem atualmente ser tratadas como chaves mestras para a conta para a qual são emitidas.

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

Tipo: apiKey
Em: header

SAS Token

Esse é um token de assinatura de acesso compartilhado criado a partir da operação LISTA SAS no recurso do Azure Mapas por meio do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.

Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado para expiração, taxa e região(s) 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 protegida 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 de mapa de 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

Solicitação de exemplo

HTTP

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 de exemplo

Código de status:: 200

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

Definições

Nome	Description
Address	O distrito administrativo e a região do país para os pontos de passagem e pontos de manobra na rota do caminhão. Observação: só há suporte para o caminhão travelMode.
AdminDistrict	O nome da subdivisão no país ou região para um endereço. Esse 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.
AdminDistrictTruck	O nome da subdivisão no país ou região para um endereço. Esse 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. A ADR é um acordo europeu relativo ao transporte internacional de mercadorias perigosas por estrada. O código de restrição do túnel ADR é usado para determinar se um veículo tem permissão para passar por um túnel com restrições no transporte de mercadorias perigosas.
AvoidEnum	Especifica as restrições que o cálculo de rota deve respeitar ao determinar a rota. Evite dar suporte a vários valores em uma solicitação e só tem suporte para a condução e o caminhão travelMode. Exemplo: "evite": ["limitedAccessHighways", "tollRoads"]
CountryRegion	Representa um país ou região, contendo detalhes relacionados.
DirectionsBatchRequestBody	A lista de consultas/solicitações de instruções a serem processadas. A lista pode conter no máximo 100 consultas e deve conter pelo menos 1 consulta.
DirectionsBatchRequestItem	Objeto De Consulta em Lote
DirectionsBatchResponse	Esse objeto é retornado de uma chamada de serviço do Lote de Direções bem-sucedida.
DirectionsBatchResponseItem	Item de resposta em lote
DrivingSideEnum	Indica a direção esquerda versus direita no ponto da manobra. `Note`: com suporte apenas para o caminhão travelMode.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
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 com suporte é o Recurso. Para obter mais informações, consulte RFC 7946.
FeatureTypeEnum	Especifica o tipo de `GeoJSON`. O único tipo de objeto com suporte é `FeatureCollection`. Para obter mais informações, consulte RFC 7946.
GeoJsonPoint	Um tipo de geometria de `GeoJSON Point` válido. Consulte RFC 7946 para obter detalhes.
Hint	Informações adicionais que podem ser úteis para seguir uma rota. Além do texto da dica, esse elemento tem um hintType de atributo que especifica o que a dica se refere, como "NextIntersection". A dica é um elemento opcional. `Note`: com suporte apenas para dirigir travelMode.
InputWaypointFeaturesItem	Especifica o ponto de entrada e o viaWaypoint `GeoJSON` objeto de recurso e propriedades adicionais. Para obter mais informações, consulte RFC 7946.
InputWaypointProperties	Especifica as propriedades de um ponto de passagem 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 uma seção de uma rota entre dois pontos de passagem. Mais informações sobre os campos contidos em uma etapa de rota:
ManeuverPointProperties	Especifica as instruções de condução e as propriedades adicionais para cada ponto de manobra na rota Leg.
ManeuverTypeEnum	O tipo de manobra descrito 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 AS APIs do Azure Mapas retornarem 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 passagem otimizado.
Order	Sequência para pontos de passagem visitantes e viaWaypoints.
PointGeometry	O ponto de origem passado como um objeto de geometria `GeoJSON` válido, do qual o polígono de intervalo deve ser calculado. Consulte RFC 7946 para obter detalhes. `Note`: a API ajustará o ponto de origem solicitado à rede rodoviária mais próxima e usará isso para cálculo de intervalo. Ele será retornado como um ponto `center` na resposta.
RegionTravelSummary	Resumo de viagens de distância, tempo e distância de estrada de pedágio por dois tipos de entidade: país (por exemplo, EUA, Canadá) e divisão administrativa ou sub-região (por exemplo, "estado" nos EUA e "província" no Canadá).
RoadTypeEnum	O tipo de estrada. `Note`: com suporte apenas para dirigir travelMode.
RouteDirectionOptimizeRouteEnum	Especifica o parâmetro a ser usado para otimizar a rota. Se não for definido, o padrão será "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. somente para roteamento de caminhão. Isso ajuda a evitar baixas liberações de ponte, restrições de estrada, curvas à direita difíceis para fornecer a rota otimizada do caminhão com base nas especificações do veículo. IS`Note`: compatível apenas com o caminhão travelMode.
RouteOutputOptionEnum	Inclua as informações de rota desejadas da resposta. Por padrão, o itinerário é incluído na resposta. Dá suporte a vários valores, como "routeOutputOptions": ["routePath", "regionMediaSummary"]
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. Esse campo se aplica somente ao último maneuverPoint.
Step	Uma etapa de rota contém instruções turno a turno. Uma etapa refere-se a um intervalo de uma rota entre dois maneuverPoint consecutivos.
SubLeg	Informações sobre um segmento da rota Leg definidos pelos pontos de passagem de rota leg e quaisquer pontos de passagem intermediários. Por exemplo, se a rota Leg tiver dois pontos de passagem além de pontos de passagem de início e de fim, haveria três (3) sub-pernas de rota.
Summary	Resumo da solicitação em lote
TrafficCongestionEnum	O nível de congestionamento de tráfego ao longo da rota. `Note`: com suporte apenas para dirigir travelMode
TrafficDataUsedEnum	O tipo de dados de tráfego em tempo real usados para gerar a rota.
TravelModeEnum	O modo de viagem para a rota solicitada. Se não for definido, o valor padrão será "dirigir" 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 toda a rota. Quando a rota do caminhão não estiver disponível para uma seção específica, o elemento travelMode da resposta dessa seção será "outro". Exemplo: "travelMode":"driving"
VehicleLoadTypeEnum	Tipos de carga que podem ser classificadas como materiais perigosos e restritas de algumas estradas. Os valores de vehicleLoadType disponíveis são as classes Hazmat dos EUA de 1 a 9, 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 outrosHazmat devem ser usados para todos os outros países. vehicleLoadType dá suporte a vários valores em uma solicitação.
ViaWaypointProperties	Especifica as propriedades de um `ViaWaypoint` que é um ponto de passagem que deve ser passado ou visitado ao longo de uma rota ou viagem.
WaypointProperties	Especifica as propriedades de um ponto de passagem que é um local ou ponto específico ao longo de uma rota ou viagem que serve como referência ou ponto de parada.

Address

Objeto

O distrito administrativo e a região do país para os pontos de passagem e pontos de manobra na rota do caminhão. Observação: só há suporte para o caminhão travelMode.

Nome	Tipo	Description
adminDistricts	AdminDistrictTruck[]	O nome da subdivisão no país ou região para um endereço. Esse 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

Objeto

O nome da subdivisão no país ou região para um endereço. Esse 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.

Nome	Tipo	Description
distanceInMeters	number	A distância total percorrida em metros dentro do distrito administrativo.
durationInSeconds	integer (int64)	Tempo estimado de viagem em segundos que não inclui atrasos na rota devido às condições de tráfego.
durationTrafficInSeconds	integer (int64)	O tempo que leva, em segundos, para percorrer um `TravelDistance` correspondente com as condições de tráfego atuais. Esse valor será fornecido se `optimizeRoute` incluir considerações de tráfego.
longName	string	O nome longo de um endereço, como Washington.
tollDistanceInMeters	number	A distância total, medida em metros, ao longo da rota que inclui estradas pedagiadas.

AdminDistrictTruck

Objeto

Nome	Tipo	Description
shortName	string	O nome curto do campo adminDistrict correspondente, For 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. A ADR é um acordo europeu relativo ao transporte internacional de mercadorias perigosas por estrada. O código de restrição do túnel ADR é usado para determinar se um veículo tem permissão para passar por um túnel com restrições no transporte de mercadorias perigosas.

Valor	Description
B	Os veículos com código B são restritos de estradas com as categorias de túnel ADR B, C, D e E.
C	Os veículos com código C são restritos de estradas com as categorias de túnel ADR C, D e E
D	Os veículos com código D são restritos de estradas com as categorias de túnel ADR D e E.
E	Os veículos com código E são restritos de estradas com a categoria de túnel ADR E.

AvoidEnum

Enumeração

Especifica as restrições que o cálculo de rota deve respeitar ao determinar a rota. Evite dar suporte a vários valores em uma solicitação e só tem suporte para a condução e o caminhão travelMode.

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

Valor	Description
borderCrossings	Evita cruzar fronteiras do país na rota.
ferries	Evita o uso de balsas na rota.
limitedAccessHighways	Evita o uso de rodovias de acesso limitado na rota.
lowEmissionZones	Evita zonas de baixa emissão na rota. `Note`: com suporte apenas para o caminhão travelMode.
tollRoads	Evita o uso de estradas pedagiadas na rota.
tunnels	Evita o uso de túneis na rota. `Note`: com suporte apenas para o caminhão travelMode.
unpavedRoads	Evita estradas não pavimentadas na rota. `Note`: com suporte apenas para o caminhão travelMode.

CountryRegion

Objeto

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

Nome	Tipo	Description
ISO	string	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

Objeto

A lista de consultas/solicitações de instruções a serem processadas. A lista pode conter no máximo 100 consultas e deve conter pelo menos 1 consulta.

Nome	Tipo	Description
batchItems	DirectionsBatchRequestItem[]	A lista de consultas a serem processadas.

DirectionsBatchRequestItem

Objeto

Objeto De Consulta em Lote

Nome	Tipo	Valor padrão	Description
arriveAt	string (date-time)		A data e a hora da chegada no ponto de destino formatado como um valor `dateTime` definido por RFC 3339, seção 5.6. Quando um deslocamento de fuso horário não for especificado, o 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. Evite dar suporte a vários valores em uma solicitação e só tem suporte para a condução e o caminhão travelMode. Exemplo: "evite": ["limitedAccessHighways", "tollRoads"]
departAt	string (date-time)		A data e hora da partida do ponto de origem formatada como um valor `dateTime` definido por RFC 3339, seção 5.6. Quando um deslocamento de fuso horário não for especificado, o UTC será assumido. Se o `departAt` não estiver definido, o valor padrão será a hora atual. Exemplo: "departAt": "2023-06-01T09:30:00.000-07:00"
features	InputWaypointFeaturesItem[]		As rotas de condução e caminhada são definidas por um conjunto de pontos de passagem(paradas) e viaWaypoints (locais intermediários pelos quais a rota deve passar). Você pode ter um máximo de 25 pontos de passagem e um máximo de 10 viaWaypoints entre cada conjunto de pontos de passagem. Não há suporte para rotas de caminhão com até 150 pontos de passagem e viaWaypoints. Uma rota deve ter um mínimo de dois pontos de passagem e os pontos de início e de término da rota não podem ser viaWaypoints. Os locais de waypoint e viaWaypoint devem ser especificados como um objeto de recurso válido do Ponto GeoJSON, 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		O título direcional inicial do veículo em graus começando no verdadeiro Norte e continuando na direção horário. Norte é 0 graus, leste é 90 graus, sul é 180 graus, oeste é 270 graus. Valores possíveis 0-359
maxRouteCount	integer (int64) minimum: 1 maximum: 3		O número máximo de rotas a serem retornadas. Disponível para os modos de viagem de caminhão e de condução. Para rotas de condução, esse parâmetro dá suporte a rotas com até dois pontos de passagem além da origem e do destino e o parâmetro de evitar não deve ser definido. Padrão: "maxRouteCount":1 Mínimo: "maxRouteCount":1 Máximo: "maxRouteCount":3
optimizeRoute	RouteDirectionOptimizeRouteEnum	fastestWithoutTraffic	Especifica o parâmetro a ser usado para otimizar a rota. Se não for definido, o padrão será "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	Solicite novamente os pontos de passagem de rota usando um algoritmo heurístico rápido para reduzir o custo de rota especificado com o parâmetro de otimização. A origem e o destino são excluídos do ponto de passagem otimizado e sua posição é considerada fixa. Valores aceitáveis são verdadeiros ou falsos. `Note`: com suporte apenas para o caminhão travelMode.
optionalId	string		ID da solicitação que seria exibida no batchItem correspondente.
routeOutputOptions	RouteOutputOptionEnum[]	[ "itinerary" ]	Inclua as informações de rota desejadas da resposta. Por padrão, o itinerário é incluído na resposta. Dá suporte a vários valores, como "routeOutputOptions": ["routePath", "regionMediaSummary"]
travelMode	TravelModeEnum	driving	O modo de viagem para a rota solicitada. Se não for definido, o valor padrão será "dirigir" 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 toda a rota. Quando a rota do caminhão não estiver disponível para uma seção específica, o elemento travelMode da resposta dessa seção será "outro". Exemplo: "travelMode":"driving"
type	FeatureTypeEnum		Especifica o tipo de `GeoJSON`. O único tipo de objeto com suporte é `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. somente para roteamento de caminhão. Isso ajuda a evitar baixas liberações de ponte, restrições de estrada, curvas à direita difíceis para fornecer a rota otimizada do caminhão com base nas especificações do veículo. `Note`: com suporte apenas para o caminhão travelMode

DirectionsBatchResponse

Objeto

Esse objeto é retornado de uma chamada de serviço do Lote de Direções bem-sucedida.

Nome	Tipo	Description
batchItems	DirectionsBatchResponseItem[]	Matriz que contém os resultados do lote.
summary	Summary	Resumo da solicitação em lote

DirectionsBatchResponseItem

Objeto

Item de resposta em lote

Nome	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 batchItem correspondente.
type	FeatureTypeEnum	Especifica o tipo de `GeoJSON`. O único tipo de objeto com suporte é `FeatureCollection`. Para obter mais informações, consulte RFC 7946.

DrivingSideEnum

Enumeração

Indica a direção esquerda versus direita no ponto da manobra. Note: com suporte apenas para o caminhão travelMode.

Valor	Description
Left	Direção do lado esquerdo.
Right	Direção do lado direito.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
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

Objeto

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

Nome	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 com suporte é `FeatureCollection`. Para obter mais informações, consulte RFC 7946.

FeaturesItem

Objeto

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

Nome	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: MultiLineStringGeometry PointGeometry	Um objeto `GeoJSON` Geometry válido. Para obter mais informações, consulte RFC 7946.
properties	FeatureProperties: ManeuverPointProperties RoutePathProperties ViaWaypointProperties WaypointProperties	Especifica as propriedades de recurso da rota, como itinerário, rota Pernas e geometria, resumo da viagem.
type	FeaturesItemTypeEnum	Especifica o tipo de `GeoJSON`. O único tipo de objeto com suporte é o Recurso. Para obter mais informações, consulte RFC 7946.

FeaturesItemTypeEnum

Enumeração

Especifica o tipo de GeoJSON. O único tipo de objeto com suporte é o Recurso. 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 com suporte é FeatureCollection. Para obter mais informações, consulte RFC 7946.

Valor	Description
FeatureCollection	Especifica o tipo de objeto `GeoJSONFeatureCollection`.

GeoJsonPoint

Objeto

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

Nome	Tipo	Description
coordinates	number[] (double)	Um `Position` é uma matriz de números com dois ou mais elementos. Os dois primeiros elementos são de longitude e de latitude, precisamente nessa ordem. 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.

Hint

Objeto

Informações adicionais que podem ser úteis para seguir uma rota. Além do texto da dica, esse elemento tem um hintType de atributo que especifica o que a dica se refere, como "NextIntersection". A dica é um elemento opcional. Note: com suporte apenas para dirigir travelMode.

Nome	Tipo	Description
hintType	string	tipo de dica.
text	string	texto de dica.

InputWaypointFeaturesItem

Objeto

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

Nome	Tipo	Description
geometry	GeoJsonPoint: PointGeometry	Um tipo de geometria de `GeoJSON Point` válido. Consulte RFC 7946 para obter detalhes.
properties	InputWaypointProperties	Especifica as propriedades de um ponto de passagem 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 com suporte é o Recurso. Para obter mais informações, consulte RFC 7946.

InputWaypointProperties

Objeto

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

Nome	Tipo	Valor padrão	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
viaWaypoint	Um viaWaypoint é um ponto de passagem específico que deve ser passado ou visitado ao longo de uma rota ou viagem. `Note`: com suporte apenas para dirigir travelMode.
waypoint	Um ponto de passagem é um local ou ponto específico ao longo de uma rota ou viagem que serve como referência ou ponto de parada.

Instruction

Objeto

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

Nome	Tipo	Description
drivingSide	DrivingSideEnum	Indica a direção esquerda versus direita no ponto da manobra. `Note`: com suporte apenas para o caminhão travelMode.
formattedText	string	A descrição de texto formatada da instrução.
hints	Hint[]	Informações adicionais que podem ser úteis para seguir uma rota. Além do texto da dica, esse elemento tem um hintType de atributo que especifica o que a dica se refere, como "NextIntersection". A dica é um elemento opcional e uma etapa de rota pode conter mais de uma dica. `Note`: com suporte apenas para dirigir travelMode
maneuverType	ManeuverTypeEnum	O tipo de manobra descrito 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 de texto sem formatação da instrução.

Leg

Objeto

Informações sobre uma seção de uma rota entre dois pontos de passagem. Mais informações sobre os campos contidos em uma etapa de rota:

Nome	Tipo	Description
arrivalAt	string (date-time)	A hora de chegada estimada para a perna, que leva em conta as condições de tráfego, é formatada como um valor dateTime definido por RFC 3339, seção 5.6. Ele fará referência ao deslocamento de fuso horário `departAt` ou `arrivalAt`. Caso contrário, a hora UTC será usada.
departureAt	string (date-time)	A hora de partida estimada para a perna, que leva em conta as condições de tráfego, é formatada como um valor dateTime definido por RFC 3339, seção 5.6. Ele fará referência ao deslocamento de fuso horário `departAt` ou `arrivalAt`. Caso contrário, a hora UTC será usada.
description	string	Uma breve descrição da rota.
distanceInMeters	number	A distância física em metros cobertos por uma perna de rota.
durationInSeconds	integer (int64)	Tempo estimado de viagem em segundos que não inclui atrasos na rota devido às condições de tráfego.
durationTrafficInSeconds	integer (int64)	O tempo que leva, em segundos, para percorrer um `TravelDistance` correspondente com as condições de tráfego atuais. Esse valor será fornecido se `optimizeRoute` incluir considerações de tráfego.
regionTravelSummary	RegionTravelSummary	Inclua o resumo de viagem de distância, tempo e distância de estrada de pedágio por dois tipos de entidade: país (por exemplo, EUA, Canadá) e divisão administrativa ou sub-região (por exemplo, "estado" nos EUA e "província" no Canadá).
routePathRange	RoutePathRange	Refere-se ao intervalo coberto por uma etapa específica de uma rota ou caminho.
subLegs	SubLeg[]	Informações sobre um segmento da rota Leg definidos pelos pontos de passagem de rota leg e quaisquer pontos de passagem intermediários. Por exemplo, se a rota Leg tiver dois pontos de passagem além de pontos de passagem de início e de fim, haveria três (3) sub-pernas de rota.

ManeuverPointProperties

Objeto

Especifica as instruções de condução e as propriedades adicionais para cada ponto de manobra na rota Leg.

Nome	Tipo	Valor padrão	Description
address	Address		O distrito administrativo e a região do país para os pontos de passagem e pontos de manobra na rota do caminhão. Observação: só há suporte para o caminhão travelMode.
compassDirection	string		A direção da viagem associada a uma manobra em uma rota, como sul ou sudoeste. `Note`: com suporte apenas para dirigir travelMode.
distanceInMeters	number		A distância física em medidores cobertos por esta etapa de rota.
durationInSeconds	integer (int64)		O tempo que leva, em segundos, para percorrer um `TravelDistance`correspondente .
exitIdentifier	string		O nome ou o 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 pontos de passagem visitantes e viaWaypoints.
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. Esse campo se aplica somente ao último maneuverPoint.
signs	string[]		Texto de sinalização para a rota. Pode haver mais de um valor de sinal.
steps	Step[]		Etapas entre dois pontos de manobra consecutivos.
towardsRoadName	string		O nome da rua para a qual a rota vai na primeira `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 descrito 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, em seguida, urso esquerda novamente.
BearLeftThenBearRight	Urso para a esquerda e, em seguida, urso para a direita.
BearLeftThenTurnLeft	Urso à esquerda e depois vire para a esquerda.
BearLeftThenTurnRight	Bear para a esquerda e depois vire para a direita.
BearRight	Urso direito.
BearRightThenBearLeft	Urso para a direita e, em seguida, urso para a esquerda.
BearRightThenBearRight	Bear direita e, em seguida, urso direita novamente.
BearRightThenTurnLeft	Fique com a direita e vire para a esquerda.
BearRightThenTurnRight	Fique com a direita e vire para a direita.
BearThenKeep	Instrução bear e, em seguida, uma instrução keep
BearThenMerge	Instrução bear 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	Insira uma rotatória.
EnterThenExitRoundabout	Insira e saia de uma rotatória.
ExitRoundabout	Saia de uma rotatória.
ExitRoundaboutLeft	Na rotatória, pegue a saída à esquerda.
ExitRoundaboutRight	Na rotatória, pegue a saída à direita.
Follow	Seguir.
GoAroundRoundabout	Vá ao redor da rotatória.
KeepLeft	Mantenha-se à esquerda em uma estrada diferente.
KeepOnRampLeft	Mantenha a esquerda e continue na rampa.
KeepOnRampRight	Mantenha a direita e continue na rampa.
KeepOnRampStraight	Mantenha-se em linha reta e continue na rampa.
KeepRight	Mantenha-se em uma estrada diferente.
KeepStraight	Mantenha-se em uma estrada diferente.
KeepToStayLeft	Mantenha a esquerda para ficar na mesma estrada.
KeepToStayRight	Mantenha a direita para ficar na mesma estrada.
KeepToStayStraight	Mantenha-se em linha reta para ficar na mesma estrada.
MergeFreeway	Mesclar em uma auto-estrada.
MergeHighway	Mesclar em uma rodovia.
MergeMotorway	Mesclar em uma auto-estrada.
MotorwayExitLeft	Pegue a saída à esquerda.
MotorwayExitRight	Pegue a saída para a 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	Fique em linha reta para pegar rampa na rodovia. Isso faz parte de uma instrução combinada.
RoadNameChange	Alterações no nome da estrada.
SwitchToMainRoad	Alterne para a estrada principal.
SwitchToParallelRoad	Alterne para a estrada paralela.
Take	Pegue a estrada. Esta instrução é usada quando você está entrando ou saindo de uma balsa.
TakeExit	Pegue a saída.
TakeFerry	Pegue a balsa.
TakeRamp	Pegue a rampa.
TakeRampLeft	Pegue a rampa para a esquerda.
TakeRampRight	Pegue a rampa para a direita.
TakeRampStraight	Fique em linha reta para pegar rampa.
TurnBack	Volte bruscamente.
TurnLeft	Vire para a esquerda.
TurnLeftSharp	Faça uma curva afiada para a esquerda.
TurnLeftThenBearLeft	Vire para a esquerda e, em seguida, a esquerda do urso.
TurnLeftThenBearRight	Vire para a esquerda e, em seguida, fique à direita.
TurnLeftThenTurnLeft	Vire para a esquerda e vire para a esquerda novamente.
TurnLeftThenTurnRight	Vire para a esquerda e vire para a direita.
TurnRight	Vire à direita.
TurnRightSharp	Dê uma curva afiada à direita.
TurnRightThenBearLeft	Vire para a direita e, em seguida, a esquerda.
TurnRightThenBearRight	Vire para a direita e, em seguida, fique à direita.
TurnRightThenTurnLeft	Vire para a direita e vire para a esquerda.
TurnRightThenTurnRight	Vire à direita e vire para a direita novamente
TurnThenMerge	Vire a instrução seguida de uma instrução de mesclagem.
TurnToStayLeft	Vire para a esquerda para ficar na mesma estrada.
TurnToStayRight	Vire à direita para ficar na mesma estrada.
UTurn	Faça uma curva para ir na direção oposta.
Unknown	A instrução é desconhecida.
Wait	Esperar
Walk	Andar

MapsErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
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 pelo ser humano do erro.
target	string	O destino do erro.

MapsErrorResponse

Objeto

Resposta de erro comum para AS APIs do Azure Mapas retornarem detalhes de erro para operações com falha.

Nome	Tipo	Description
error	MapsErrorDetail	O detalhe do erro.

MapsInnerError

Objeto

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

Nome	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

Objeto

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

Nome	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

Objeto

Objeto de ponto de passagem otimizado.

Nome	Tipo	Description
inputIndex	integer (int64)	Índice de ponto de passagem fornecido pelo usuário.
optimizedIndex	integer (int64)	Índice de ponto de passagem otimizado do sistema.

Order

Objeto

Sequência para pontos de passagem visitantes e viaWaypoints.

Nome	Tipo	Description
inputIndex	integer (int64)	Índice fornecido pelo usuário para entradas waypoint e viaWaypoint.
optimizedIndex	integer (int64)	Ponto de passagem com otimização do sistema e índice viaWaypoint.

PointGeometry

Objeto

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

Note: a API ajustará o ponto de origem solicitado à rede rodoviária mais próxima e usará isso para cálculo de intervalo. Ele será retornado como um ponto center na resposta.

Nome	Tipo	Description
coordinates	number[] (double)	Um `Position` é uma matriz de números com dois ou mais elementos. Os dois primeiros elementos são de longitude e de latitude, precisamente nessa ordem. 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.

RegionTravelSummary

Objeto

Resumo de viagens de distância, tempo e distância de estrada de pedágio por dois tipos de entidade: país (por exemplo, EUA, Canadá) e divisão administrativa ou sub-região (por exemplo, "estado" nos EUA e "província" no Canadá).

Nome	Tipo	Description
adminDistricts	AdminDistrict[]	matriz adminDistrict.
countryRegion	CountryRegion	Representa um país ou região, contendo detalhes relacionados.
distanceInMeters	number	Propriedade Length In Meters
durationInSeconds	integer (int64)	Tempo estimado de viagem em segundos que não inclui atrasos na rota devido às condições de tráfego.
durationTrafficInSeconds	integer (int64)	O tempo que leva, em segundos, para percorrer um `TravelDistance` correspondente com as condições de tráfego atuais. Esse valor será fornecido se `optimizeRoute` incluir considerações de tráfego.
tollDistanceInMeters	number	A distância total, medida em metros, ao longo da rota que inclui estradas pedagiadas.

RoadTypeEnum

Enumeração

O tipo de estrada. Note: com suporte apenas para dirigir travelMode.

Valor	Description
Arterial	Arterial.
Ferry	Balsa.
Highway	Rodovia.
LimitedAccessHighway	LimitedAccessHighway.
MajorRoad	MajorRoad.
NotApplicable	NotApplicable.
Ramp	Rampa.
Street	Rua.
WalkingPath	WalkingPath.

RouteDirectionOptimizeRouteEnum

Enumeração

Especifica o parâmetro a ser usado para otimizar a rota. Se não for definido, o padrão será "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
fastestAvoidClosureWithoutTraffic	A rota é calculada para minimizar o tempo e evitar fechamentos de estradas. Nenhuma informação de tráfego, exceto fechamentos de estradas, é usada no cálculo. `Note`: com suporte apenas para dirigir travelMode.
fastestWithTraffic	A rota é calculada para minimizar o tempo usando as informações de tráfego atuais. `Note`: com suporte apenas para a condução e o caminhão travelMode.
fastestWithoutTraffic	Localiza a rota mais rápida, sem considerar as informações de tráfego.
shortest	A rota é calculada para minimizar a distância. As informações de tráfego não são usadas.

RouteDirectionVehicleSpec

Objeto

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

ISNote: compatível apenas com o caminhão travelMode.

Nome	Tipo	Valor padrão	Description
adrTunnelRestrictionCode	AdrTunnelRestrictionCodeEnum		O código de restrição do túnel ADR. A ADR é um acordo europeu relativo ao transporte internacional de mercadorias perigosas por estrada. O código de restrição do túnel ADR é usado para determinar se um veículo tem permissão para passar por um túnel com restrições no transporte de mercadorias perigosas.
axleCount	integer (int64)		O número de eixos no veículo.
axleWeight	integer (int64) minimum: 0 maximum: 1000000	0	Peso por eixo do veículo em kg. Um valor de 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 de 0 significa que as restrições de altura não são consideradas.
isVehicleCommercial	boolean	False	Se o veículo é usado para fins comerciais. Veículos comerciais podem não ter permissão para dirigir 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 classificadas como materiais perigosos e restritas de algumas estradas. Os valores de vehicleLoadType disponíveis são as classes Hazmat dos EUA de 1 a 9, 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 outrosHazmat devem ser usados para todos os outros países. vehicleLoadType dá suporte a 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 é usada para verificar se um veículo é permitido em auto-estradas. Um valor de 0 significa que um valor apropriado para o veículo será determinado e aplicado durante o planejamento da rota. Um valor diferente de zero pode ser substituído durante o planejamento de rota. Por exemplo, o fluxo de tráfego atual é de 60 km/hora. Se a velocidade máxima do veículo for definida como 50 km/hora, o motor de roteamento considerará 60 km/hora, pois essa é 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 mecanismo de roteamento usará novamente 60 km/hora.
weight	integer (int64) minimum: 0 maximum: 1000000	0	Peso do veículo em quilogramas. Um valor de 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.

Dá suporte a vários valores, como "routeOutputOptions": ["routePath", "regionMediaSummary"]

Valor	Description
itinerary	Inclua instruções detalhadas na resposta. As instruções detalhadas são fornecidas como "ManeuverPoints" e contêm detalhes, como instruções turno a turno.
regionTravelSummary	Inclua o resumo de viagem de distância, tempo e distância de estrada de pedágio por dois tipos de entidade: país (por exemplo, EUA, Canadá) e divisão administrativa ou sub-região (por exemplo, "estado" nos EUA e "província" no Canadá). `Note`: Suporte apenas para condução e caminhada travelMode
routePath	Inclua um GEOJSON MultiLineString 7946, seção 3.1.5 que descrevem o caminho da rota na resposta.
routeSummary	Inclua apenas o tempo de viagem e a distância da rota e não forneça outras informações.

RoutePathPoint

Objeto

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

Nome	Tipo	Description
legIndex	integer (int64)	O índice leg de rota é um número sequencial atribuído a cada Etapa 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

Objeto

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

Nome	Tipo	Description
arrivalAt	string (date-time)	A hora de chegada estimada da perna, que leva em conta as condições de tráfego, é formatada como um valor `dateTime` definido por RFC 3339, seção 5.6. Ele fará referência ao deslocamento de fuso horário `departAt` ou `arrivalAt`. Caso contrário, a hora UTC será usada.
departureAt	string (date-time)	A hora de partida estimada para a perna, que leva em conta as condições de tráfego, é formatada como um valor `dateTime` definido por RFC 3339, seção 5.6. Ele fará referência ao deslocamento de fuso horário `departAt` ou `arrivalAt`. Caso contrário, a hora UTC será usada.
distanceInMeters	number	A distância física em metros cobertos por toda a rota.
durationInSeconds	integer (int64)	Tempo estimado de viagem em segundos que não inclui atrasos na rota devido às condições de tráfego.
durationTrafficInSeconds	integer (int64)	O tempo que leva, em segundos, para percorrer um `TravelDistance` correspondente com as condições de tráfego atuais. Esse valor será fornecido se `optimizeRoute` incluir considerações de tráfego.
legs	Leg[]	Uma matriz de pernas de rota. Verifique a descrição do objeto Leg de rota para obter mais informações.
optimizedWaypoints	OptimizedWaypoint[]	Sequência otimizada de pontos de passagem. Ele mostra o índice da sequência de pontos de passagem fornecida pelo usuário para as listas originais e otimizadas.
resourceId	string	Uma ID exclusiva para o recurso.
trafficCongestion	TrafficCongestionEnum	O nível de congestionamento de tráfego ao longo da rota. `Note`: com suporte apenas para dirigir travelMode
trafficDataUsed	TrafficDataUsedEnum	O tipo de dados de tráfego em tempo real usados para gerar a rota.
type	string: RoutePath	Tipo de saída.

RoutePathRange

Objeto

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

Nome	Tipo	Description
legIndex	integer (int64)	O índice leg de rota é um número sequencial atribuído a cada Etapa 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.
other	Route TravelMode é 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.
truck	Rotas otimizadas para caminhões de grande tamanho com base na especificação do veículo.
walking	Rotas otimizadas para pedestres.

SideOfStreetEnum

Enumeração

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

Valor	Description
Left	Esquerda.
Right	Certo.
Unknown	Desconhecido.

Step

Objeto

Uma etapa de rota contém instruções turno a turno. Uma etapa refere-se a um intervalo de uma rota entre dois maneuverPoint consecutivos.

Nome	Tipo	Description
compassDegrees	number	A direção em graus. `Note`: com suporte apenas para dirigir travelMode.
maneuverType	ManeuverTypeEnum	O tipo de manobra descrito 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 a manobra ocorre. Se a manobra for complexa, poderá 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.
roadType	RoadTypeEnum	O tipo de estrada. `Note`: com suporte apenas para dirigir travelMode.
routePathRange	RoutePathRange	Refere-se ao intervalo coberto por uma etapa específica de uma rota ou caminho.

SubLeg

Objeto

Informações sobre um segmento da rota Leg definidos pelos pontos de passagem de rota leg e quaisquer pontos de passagem intermediários. Por exemplo, se a rota Leg tiver dois pontos de passagem além de pontos de passagem de início e de fim, haveria três (3) sub-pernas de rota.

Nome	Tipo	Description
distanceInMeters	number	A distância física em metros cobertos pela sub-perna.
durationInSeconds	integer (int64)	Tempo estimado de viagem em segundos que não inclui atrasos na rota devido às condições de tráfego.
durationTrafficInSeconds	integer (int64)	O tempo que leva, em segundos, para percorrer um `TravelDistance` correspondente com as condições de tráfego atuais. Esse valor será 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.

Summary

Objeto

Resumo da solicitação em lote

Nome	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 de tráfego ao longo da rota. Note: com suporte apenas para dirigir travelMode

Valor	Description
Heavy	Pesado.
Medium	Média.
Mild	Moderada.
None	Nenhum.
Unknown	Desconhecido.

TrafficDataUsedEnum

Enumeração

O tipo de dados de tráfego em tempo real usados para gerar a rota.

Valor	Description
Closure	Dados de fechamento em tempo real usados, se aplicável.
Flow	Velocidades de tráfego em tempo real usadas para calcular o tempo de viagem.
FlowAndClosure	Fluxo e fechamento.
None	Nenhum.

TravelModeEnum

Enumeração

O modo de viagem para a rota solicitada. Se não for definido, o valor padrão será "dirigir" 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 toda a rota. Quando a rota do caminhão não estiver disponível para uma seção específica, o elemento travelMode da resposta dessa seção será "outro".

Exemplo: "travelMode":"driving"

Valor	Description
driving	As rotas retornadas são otimizadas para carros.
truck	As rotas retornadas são otimizadas para caminhões de grande tamanho com base na especificação do veículo.
walking	As rotas retornadas são otimizadas para pedestres, incluindo o uso de calçadas.

VehicleLoadTypeEnum

Enumeração

Tipos de carga que podem ser classificadas como materiais perigosos e restritas de algumas estradas. Os valores de vehicleLoadType disponíveis são as classes Hazmat dos EUA de 1 a 9, 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 outrosHazmat devem ser usados para todos os outros países. vehicleLoadType dá suporte a vários valores em uma solicitação.

Valor	Description
USHazmatClass1	Explosivos
USHazmatClass2	Gás compactado
USHazmatClass3	Líquidos inflamáveis
USHazmatClass4	Sólidos inflamáveis
USHazmatClass5	Oxidantes
USHazmatClass6	Venenos
USHazmatClass7	Radioativo
USHazmatClass8	Corrosivos
USHazmatClass9	Diversos
otherHazmatExplosive	Explosivos
otherHazmatGeneral	Diversos
otherHazmatHarmfulToWater	Prejudicial à água

ViaWaypointProperties

Objeto

Especifica as propriedades de um ViaWaypoint que é um ponto de passagem que deve ser passado ou visitado ao longo de uma rota ou viagem.

Nome	Tipo	Description
names	string[]	Uma rua, rodovia ou cruzamento onde a manobra ocorre. Se a manobra for complexa, poderá 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.
order	Order	Sequência para pontos de passagem visitantes e viaWaypoints.
routePathPoint	RoutePathPoint	Refere-se ao índice de um ponto dentro de uma etapa específica de uma rota.
type	string: ViaWaypoint	Tipo de saída.

WaypointProperties

Objeto

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

Nome	Tipo	Valor padrão	Description
address	Address		O distrito administrativo e a região do país para os pontos de passagem e pontos de manobra na rota do caminhão. Observação: só há suporte para o caminhão travelMode.
compassDirection	string		A direção da viagem associada a uma manobra em uma rota, como sul ou sudoeste. `Note`: com suporte apenas para dirigir travelMode.
distanceInMeters	number		A distância física em medidores cobertos por esta etapa de rota.
durationInSeconds	integer (int64)		O tempo que leva, em segundos, para percorrer um `TravelDistance`correspondente .
exitIdentifier	string		O nome ou o 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 pontos de passagem visitantes e viaWaypoints.
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. Esse campo se aplica somente ao último maneuverPoint.
signs	string[]		Texto de sinalização para a rota. Pode haver mais de um valor de sinal.
steps	Step[]		Etapas entre dois pontos de manobra consecutivos.
towardsRoadName	string		O nome da rua para a qual a rota vai na primeira `ManeuverPoint`.
travelMode	RoutePathTravelModeEnum	driving	O modo de viagem para o caminho da rota na resposta.
type	string: Waypoint		Tipo de saída.

Compartilhar via

Route - Post Route Directions Batch

Enviar solicitação de lote síncrona

Corpo POST para solicitação em lote

Modelo de resposta em lote

Parâmetros de URI

Cabeçalho da solicitação

Corpo da solicitação

Respostas

Segurança

AADToken

Escopos

subscription-key

SAS Token

Exemplos

A Route Directions Batch request containing 2 queries

Solicitação de exemplo

Resposta de exemplo

Definições

Address

AdminDistrict

AdminDistrictTruck

AdrTunnelRestrictionCodeEnum

AvoidEnum

CountryRegion

DirectionsBatchRequestBody

DirectionsBatchRequestItem

DirectionsBatchResponse

DirectionsBatchResponseItem

DrivingSideEnum

ErrorAdditionalInfo

ErrorDetail

FeatureCollection

FeaturesItem

FeaturesItemTypeEnum

FeatureTypeEnum

GeoJsonPoint

Hint

InputWaypointFeaturesItem

InputWaypointProperties

InputWaypointTypeEnum

Instruction

Leg

ManeuverPointProperties

ManeuverTypeEnum

MapsErrorDetail

MapsErrorResponse

MapsInnerError

MultiLineStringGeometry

OptimizedWaypoint

Order

PointGeometry

RegionTravelSummary

RoadTypeEnum

RouteDirectionOptimizeRouteEnum

RouteDirectionVehicleSpec

RouteOutputOptionEnum

RoutePathPoint

RoutePathProperties

RoutePathRange

RoutePathTravelModeEnum

SideOfStreetEnum

Step

SubLeg

Summary

TrafficCongestionEnum

TrafficDataUsedEnum

TravelModeEnum

VehicleLoadTypeEnum

ViaWaypointProperties

WaypointProperties