Route - Get Route Directions Batch

Referência

Serviço:: Maps

Versão da API:: 1.0

Use para enviar um lote de consultas para o Obter direções de rota API em uma única solicitação assíncrona.

Observação

de desativação do serviço Azure Maps Route v1

O serviço de do Azure Maps Route v1 foi preterido e será desativado em 31/03/28. Para evitar interrupções no serviço, todas as chamadas para o serviço Route v1 precisarão ser atualizadas para usar serviço de do Route v2025-01-01 até 31/03/28. Para obter mais informações, consulte migrar APIs do Azure Maps Route 1.0.

A API Get Route Directions Batch é uma solicitação de GET HTTP que envia lotes de consultas para a API Obter Direções de Rota usando uma única solicitação. Você pode chamar Get Route Directions Batch API para ser executada de forma assíncrona (assíncrona) ou síncrona (sincronização). A API assíncrona permite que o chamador agrupe até 700 consultas e sincronize a API até 100 consultas.

Baixar resultados de lote assíncronos

Para baixar os resultados do lote assíncrono, você emitirá uma solicitação de GET para o ponto de extremidade de download em lote. Este URL de download pode ser obtido a partir do cabeçalho Location de uma solicitação de lote de POST bem-sucedida e tem a seguinte aparência:

https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Aqui está a sequência típica de operações para baixar os resultados do lote:

O cliente envia uma solicitação de GET usando o URL de download .
O servidor responderá com uma das seguintes opções:

HTTP 202 Accepted - A solicitação em lote foi aceita, mas ainda está sendo processada. Por favor, tente novamente dentro de algum tempo.

HTTP 200 OK - Solicitação em lote processada com sucesso. O corpo da resposta contém todos os resultados do lote.

Modelo de resposta em lote

O conteúdo de dados retornado é semelhante para solicitações assíncronas e de sincronização. Ao baixar os resultados de uma solicitação de lote assíncrona, se o lote tiver terminado o processamento, o corpo da resposta conterá a resposta em lote. Essa resposta em lote contém um componente summary que indica os totalRequests que faziam parte da solicitação de lote original e successfulRequestsou 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 no batchItems contém statusCode e response campos. Cada response em batchItems é de um dos seguintes tipos:

RouteDirections - Se a consulta foi concluída com êxito.
Error - Se a consulta falhou. Neste caso, a resposta conterá um code e um message.

Aqui está um exemplo de resposta em lote com 1 bem-sucedido e 1 resultado falhado:

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

GET https://atlas.microsoft.com/route/directions/batch/{format}?api-version=1.0

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
format	path	True	string	ID do lote para consultar a operação.
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	Especifica qual conta deve ser usada em conjunto com o modelo de segurança do Microsoft Entra ID. Ele representa uma ID exclusiva para a conta do Azure Maps e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Maps. Para usar a segurança do Microsoft Entra ID no Azure Maps, consulte os seguintes artigos para obter orientação.

Respostas

Name	Tipo	Description
200 OK	RouteDirectionsBatchResult	Pedido de lote processado com sucesso. O corpo da resposta contém todos os resultados do lote.
202 Accepted		Suportado apenas para solicitação assíncrona. Pedido aceite: O pedido foi aceite para processamento. Utilize o URL no cabeçalho da localização para repetir ou aceder aos resultados. Cabeçalhos Location: string
Other Status Codes	ErrorResponse	Ocorreu um erro inesperado.

Name

Tipo

Description

200 OK

RouteDirectionsBatchResult

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

202 Accepted

Suportado apenas para solicitação assíncrona. Pedido aceite: O pedido foi aceite para processamento. Utilize o URL no cabeçalho da localização para repetir ou aceder aos resultados.

Cabeçalhos

Location: string

Other Status Codes

ErrorResponse

Ocorreu um erro inesperado.

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.

Observações

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

Esta é uma chave compartilhada que é provisionada quando você Criar uma conta do Azure Maps no portal do Azure ou usando PowerShell, CLI, SDKs do Azure ou API REST.

Com essa chave, qualquer aplicativo pode acessar todas as APIs REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta em que eles são emitidos.

Para aplicativos expostos publicamente, nossa recomendação é usar a abordagem de de aplicativos cliente confidenciais para acessar APIs REST do Azure Maps para que sua chave possa ser armazenada com segurança.

Tipo: apiKey
Em: query

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

Successfully retrieve the status for the route direction batch request

Pedido de amostra

HTTP

GET https://atlas.microsoft.com/route/directions/batch/11111111-2222-3333-4444-555555555555?api-version=1.0

Resposta da amostra

Código de estado:: 200

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

Código de estado:: 202

Definições

Name	Description
DelayMagnitude	A magnitude do atraso causado pelo incidente. Esses valores correspondem aos valores do campo de resposta do Get Traffic Incident Detail API.
DrivingSide	Indica a condução à esquerda vs. à direita no ponto da manobra.
EffectiveSetting	Parâmetro ou dados efetivos usados ao chamar essa API de rota.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
GuidanceInstructionType	Tipo de instrução, por exemplo, virar ou mudar de forma de estrada.
GuidanceManeuver	Um código que identifica a manobra.
JunctionType	O tipo de entroncamento onde ocorre a manobra. Para rotundas maiores, são geradas duas instruções separadas para entrar e sair da rotunda.
LatLongPair	Um local representado como latitude e longitude.
Response	O resultado da consulta. RouteDirections se a consulta for concluída com êxito, ErrorResponse caso contrário.
ResponseSectionType	Tipos de seção da resposta de rota relatada
ResponseTravelMode	Modo de viagem para a rota calculada. O valor será definido como `other` se o modo de transporte solicitado não for possível nesta seção
Route
RouteDirectionsBatchItem	Um item retornado da chamada de serviço Route Directions Batch.
RouteDirectionsBatchResult	Este objeto é retornado de uma chamada de serviço Route Directions Batch bem-sucedida.
RouteGuidance	Contém elementos relacionados com orientações. Este campo está presente apenas quando a orientação foi solicitada e está disponível.
RouteInstruction	Um conjunto de atributos que descrevem uma manobra, por exemplo, «Vire à direita», «Mantenha-se à esquerda», «Apanhe o ferry», «Apanhe a autoestrada», «Chegar».
RouteInstructionGroup	Agrupa uma sequência de elementos de instrução que estão relacionados entre si. O intervalo de sequência é restrito com firstInstructionIndex e lastInstructionIndex. Quando mensagens de texto legíveis por humanos são solicitadas para orientação (instructionType=text ou tagged), o instructionGroup tem uma mensagem de resumo retornada quando disponível.
RouteLeg	Descrição de uma parte de um percurso, composta por uma lista de pontos. Cada waypoint adicional fornecido na solicitação resultará em um trecho adicional na rota devolvida.
RouteLegSummary	Objeto de resumo para a seção de rota.
RouteOptimizedWaypoint	Objeto de ponto de caminho otimizado.
RouteReport	Relata as configurações efetivas usadas na chamada atual.
RouteSection	As seções de rota contêm informações adicionais sobre partes de uma rota. Cada seção contém pelo menos os elementos `startPointIndex`, `endPointIndex`e `sectionType`.
RouteSectionTec	Detalhes do evento de tráfego, usando definições no TPEG2-TEC padrão. Pode conter elementos effectCode e causas.
RouteSectionTecCause	A causa do evento de trânsito. Pode conter elementos mainCauseCode e subCauseCode. Pode ser usado para definir iconografia e descrições.
RouteSummary	Objeto de resumo
SimpleCategory	Tipo de incidente. Atualmente pode ser JAM, ROAD_WORK, ROAD_CLOSURE ou OUTRO. Consulte "tec" para obter informações detalhadas.
Summary	Resumo dos resultados do pedido de lote

DelayMagnitude

Enumeração

A magnitude do atraso causado pelo incidente. Esses valores correspondem aos valores do campo de resposta do Get Traffic Incident Detail API.

Valor	Description
0	Desconhecido.
1	Menor.
2	Moderado.
3	Major.
4	Indefinido, usado para fechamentos de estradas e outros atrasos indefinidos.

DrivingSide

Enumeração

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

Valor	Description
LEFT	Lado esquerdo.
RIGHT	Lado direito.

EffectiveSetting

Object

Parâmetro ou dados efetivos usados ao chamar essa API de rota.

Name	Tipo	Description
key	string	Nome do parâmetro utilizado.
value	string	Valor do parâmetro utilizado.

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.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

GuidanceInstructionType

Enumeração

Tipo de instrução, por exemplo, virar ou mudar de forma de estrada.

Valor	Description
DIRECTION_INFO	Informações de direção.
LOCATION_ARRIVAL	Local de chegada.
LOCATION_DEPARTURE	Local de partida.
LOCATION_WAYPOINT	Localização do ponto de passagem.
ROAD_CHANGE	Mudança de estrada.
TURN	Vira a página.

GuidanceManeuver

Enumeração

Um código que identifica a manobra.

Valor	Description
ARRIVE	Chegou.
ARRIVE_LEFT	Chegou. Seu destino está à esquerda.
ARRIVE_RIGHT	Chegou. Seu destino está à direita.
BEAR_LEFT	Urso à esquerda.
BEAR_RIGHT	Ter razão.
DEPART	Saia.
ENTER_FREEWAY	Pegue a rodovia.
ENTER_HIGHWAY	Pegue a rodovia.
ENTER_MOTORWAY	Pegue a estrada.
ENTRANCE_RAMP	Pegue a rampa.
FOLLOW	Acompanhe.
KEEP_LEFT	Mantenha-se à esquerda.
KEEP_RIGHT	Mantenha-se à direita.
MAKE_UTURN	Faça uma inversão de marcha.
MOTORWAY_EXIT_LEFT	Pegue a saída à esquerda.
MOTORWAY_EXIT_RIGHT	Pegue a saída à direita.
ROUNDABOUT_BACK	Contorne a rotunda.
ROUNDABOUT_CROSS	Atravesse a rotatória.
ROUNDABOUT_LEFT	Na rotatória, pegue a saída à esquerda.
ROUNDABOUT_RIGHT	Na rotatória, pegue a saída à direita.
SHARP_LEFT	Vire bem à esquerda.
SHARP_RIGHT	Vire bem à direita.
STRAIGHT	Mantenha-se em frente.
SWITCH_MAIN_ROAD	Mude para a estrada principal.
SWITCH_PARALLEL_ROAD	Mude para a estrada paralela.
TAKE_EXIT	Pegue a saída.
TAKE_FERRY	Pegue a balsa.
TRY_MAKE_UTURN	Tente fazer uma inversão de marcha.
TURN_LEFT	Vire à esquerda.
TURN_RIGHT	Vire à direita.
WAYPOINT_LEFT	Chegou ao ponto de passagem. Está à esquerda.
WAYPOINT_REACHED	Chegou ao ponto de passagem.
WAYPOINT_RIGHT	Chegou ao ponto de passagem. Está à direita.

JunctionType

Enumeração

O tipo de entroncamento onde ocorre a manobra. Para rotundas maiores, são geradas duas instruções separadas para entrar e sair da rotunda.

Valor	Description
BIFURCATION	bifurcação
REGULAR	regular
ROUNDABOUT	rotunda

LatLongPair

Object

Um local representado como latitude e longitude.

Name	Tipo	Description
latitude	number (double)	Propriedade Latitude
longitude	number (double)	Propriedade Longitude

Response

Object

O resultado da consulta. RouteDirections se a consulta for concluída com êxito, ErrorResponse caso contrário.

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.
formatVersion	string	Propriedade Format Version
optimizedWaypoints	RouteOptimizedWaypoint[]	Sequência otimizada de waypoints. Ele mostra o índice da sequência de waypoint fornecida pelo usuário para a lista original e otimizada. Por exemplo, uma resposta: `<optimizedWaypoints> <waypoint providedIndex="0" optimizedIndex="1"/> <waypoint providedIndex="1" optimizedIndex="2"/> <waypoint providedIndex="2" optimizedIndex="0"/> </optimizedWaypoints>` significa que a sequência original é [0, 1, 2] e a sequência otimizada é [1, 2, 0]. Como o índice começa por 0, o original é "primeiro, segundo, terceiro", enquanto o otimizado é "segundo, terceiro, primeiro".
report	RouteReport	Relata as configurações efetivas usadas na chamada atual.
routes	Route[]	Matriz de rotas

ResponseSectionType

Enumeração

Tipos de seção da resposta de rota relatada

Valor	Description
CARPOOL	Troços do percurso que requerem a utilização de faixas de carpool (HOV/High Occupancy Vehicle).
CAR_TRAIN	Troços do percurso que são carros ou comboios.
COUNTRY	Secções que indicam em que países/regiões se encontra a rota.
FERRY	Troços do percurso que são ferries.
MOTORWAY	Troços do percurso que são autoestradas.
PEDESTRIAN	Troços do percurso que só servem para peões.
TOLL_ROAD	Troços do percurso que exigem o pagamento de portagens.
TOLL_VIGNETTE	Troços do percurso que requerem vinheta de portagem para estarem presentes.
TRAFFIC	Seções da rota que contêm informações de tráfego.
TRAVEL_MODE	Seções em relação ao parâmetro request `travelMode`.
TUNNEL	Troços do percurso que são túneis.
URBAN	Troços do percurso situados em zonas urbanas.

ResponseTravelMode

Enumeração

Modo de viagem para a rota calculada. O valor será definido como other se o modo de transporte solicitado não for possível nesta seção

Valor	Description
bicycle	As rotas devolvidas são otimizadas para bicicletas, incluindo o uso de ciclovias.
bus	As rotas de retorno são otimizadas para ônibus, incluindo o uso de faixas exclusivas para ônibus. Funcionalidade BETA.
car	As rotas devolvidas são otimizadas para carros.
motorcycle	As rotas devolvidas são otimizadas para motocicletas. Funcionalidade BETA.
other	O modo de transporte indicado não é possível nesta secção
pedestrian	As rotas de retorno são otimizadas para pedestres, incluindo o uso de calçadas.
taxi	As rotas devolvidas são otimizadas para táxis. Funcionalidade BETA.
truck	As rotas de retorno são otimizadas para veículos comerciais, como para caminhões.
van	As rotas devolvidas são otimizadas para vans. Funcionalidade BETA.

Route

Object

Name	Tipo	Description
guidance	RouteGuidance	Contém elementos relacionados com orientações. Este campo está presente apenas quando a orientação foi solicitada e está disponível.
legs	RouteLeg[]	Arranjo de pernas
sections	RouteSection[]	Matriz de seções
summary	RouteSummary	Objeto de resumo

RouteDirectionsBatchItem

Object

Um item retornado da chamada de serviço Route Directions Batch.

Name	Tipo	Description
response	Response	O resultado da consulta. RouteDirections se a consulta for concluída com êxito, ErrorResponse caso contrário.
statusCode	integer	Código de status da solicitação HTTP.

RouteDirectionsBatchResult

Object

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

Name	Tipo	Description
batchItems	RouteDirectionsBatchItem[]	Matriz que contém os resultados do lote.
summary	Summary	Resumo dos resultados do pedido de lote

RouteGuidance

Object

Contém elementos relacionados com orientações. Este campo está presente apenas quando a orientação foi solicitada e está disponível.

Name	Tipo	Description
instructionGroups	RouteInstructionGroup[]	Agrupa uma sequência de elementos de instrução que estão relacionados entre si.
instructions	RouteInstruction[]	Uma lista de instruções descrevendo manobras.

RouteInstruction

Object

Um conjunto de atributos que descrevem uma manobra, por exemplo, «Vire à direita», «Mantenha-se à esquerda», «Apanhe o ferry», «Apanhe a autoestrada», «Chegar».

Name	Tipo	Description
combinedMessage	string	Uma mensagem legível por humanos para a manobra combinada com a mensagem da próxima instrução. Às vezes, é possível combinar duas instruções sucessivas em uma única instrução, tornando mais fácil de seguir. Quando este for o caso, o sinalizador possibleCombineWithNext será true. Por exemplo: `10. Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam 11. Follow Einsteinweg/A10/E22 towards Ring Amsterdam` O sinalizador possibleCombineWithNext na instrução 10 é true. Isso indica aos clientes da orientação codificada que ela pode ser combinada com a instrução 11. As instruções serão combinadas automaticamente para clientes que solicitem orientação legível por humanos. O campo combinedMessage contém a mensagem combinada: `Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam then follow Einsteinweg/A10/E22 towards Ring Amsterdam.`
countryCode	string	3 caracteres código de país ISO 3166-1 alpha-3. Por exemplo, EUA.
drivingSide	DrivingSide	Indica a condução à esquerda vs. à direita no ponto da manobra.
exitNumber	string	O(s) número(s) de uma saída de rodovia tomada pela manobra atual. Se uma saída tiver vários números de saída, eles serão separados por "," e possivelmente agregados por "-", por exemplo, "10, 13-15".
instructionType	GuidanceInstructionType	Tipo de instrução, por exemplo, virar ou mudar de forma de estrada.
junctionType	JunctionType	O tipo de entroncamento onde ocorre a manobra. Para rotundas maiores, são geradas duas instruções separadas para entrar e sair da rotunda.
maneuver	GuidanceManeuver	Um código que identifica a manobra.
message	string	Uma mensagem legível por humanos para a manobra.
point	LatLongPair	Um local representado como latitude e longitude.
pointIndex	integer	O índice do ponto na lista de "pontos" de polilinha correspondente ao ponto da instrução.
possibleCombineWithNext	boolean	Opcionalmente, é possível combinar a instrução com a próxima. Isso pode ser usado para criar mensagens como "Vire à esquerda e depois vire à direita".
roadNumbers	string[]	Número(s) de estrada do(s) próximo(s) segmento(s) de estrada significativo(s) após a manobra, ou da(s) estrada(s) a seguir. Exemplo: ["E34", "N205"]
roundaboutExitNumber	integer (int64)	Isso indica qual saída tomar em uma rotatória.
routeOffsetInMeters	integer	Distância desde o início do percurso até ao ponto da instrução.
signpostText	string	O texto em uma placa de sinalização que é mais relevante para a manobra, ou para a direção que deve ser seguida.
stateCode	string	Uma subdivisão (por exemplo, estado) do país, representada pela segunda parte de um código ISO 3166-2. Isso só está disponível para alguns países/regiões, como EUA, Canadá e México.
street	string	Nome da rua do próximo segmento significativo da estrada após a manobra, ou da rua que deve ser seguida.
travelTimeInSeconds	integer	Tempo de viagem estimado até o ponto correspondente a routeOffsetInMeters.
turnAngleInDecimalDegrees	integer	Indica a direção de uma instrução. Se junctionType indicar uma instrução de volta: 180 = Retorno em U [-179, -1] = Virar à esquerda 0 = Em linha reta (uma volta de '0 grau') [1, 179] = Virar à direita Se junctionType indicar uma instrução de bifurcação: <0 - mantenha-se à esquerda >0 - mantenha-se à direita

RouteInstructionGroup

Object

Agrupa uma sequência de elementos de instrução que estão relacionados entre si. O intervalo de sequência é restrito com firstInstructionIndex e lastInstructionIndex. Quando mensagens de texto legíveis por humanos são solicitadas para orientação (instructionType=text ou tagged), o instructionGroup tem uma mensagem de resumo retornada quando disponível.

Name	Tipo	Description
firstInstructionIndex	integer	Índice da primeira instrução nas instruções e pertencente a este grupo.
groupLengthInMeters	integer	Comprimento do grupo.
groupMessage	string	Mensagem de resumo quando mensagens de texto legíveis por humanos são solicitadas para orientação (instructionType=text ou tagged).
lastInstructionIndex	integer	Índice da última instrução nas instruções e pertencente a este grupo.

RouteLeg

Object

Descrição de uma parte de um percurso, composta por uma lista de pontos. Cada waypoint adicional fornecido na solicitação resultará em um trecho adicional na rota devolvida.

Name	Tipo	Description
points	LatLongPair[]	Matriz de pontos
summary	RouteLegSummary	Objeto de resumo para a seção de rota.

RouteLegSummary

Object

Objeto de resumo para a seção de rota.

Name	Tipo	Description
arrivalTime	string (date-time)	A hora prevista de chegada para o percurso ou trecho. A hora está em UTC.
batteryConsumptionInkWh	number (double)	Consumo estimado de energia elétrica em quilowatts-hora (kWh) utilizando o Modelo de Consumo Elétrico. Incluído se vehicleEngineType estiver definido como elétrico e constantSpeedConsumptionInkWhPerHundredkm for especificado. O valor da bateriaConsumoInkWh inclui a energia elétrica recuperada e, portanto, pode ser negativo (o que indica ganho de energia). Se maxChargeInkWh e currentChargeInkWh forem especificados, a recuperação será limitada para garantir que o nível de carga da bateria nunca exceda maxChargeInkWh. Se nem maxChargeInkWh nem currentChargeInkWh forem especificados, a recuperação sem restrições é assumida no cálculo do consumo.
departureTime	string (date-time)	A hora de partida estimada para a rota ou trecho. A hora está em UTC.
fuelConsumptionInLiters	number (double)	Consumo de combustível estimado em litros utilizando o Modelo de Consumo de Combustão. Incluído se vehicleEngineType estiver definido para de combustão e constantSpeedConsumptionInLitersPerHundredkm for especificado. O valor não será negativo.
historicTrafficTravelTimeInSeconds	integer	Tempo de viagem estimado calculado utilizando dados históricos de tráfego dependentes do tempo. Incluído somente se computeTravelTimeFor = all for usado na consulta.
lengthInMeters	integer	Comprimento em metros propriedade
liveTrafficIncidentsTravelTimeInSeconds	integer	Tempo de viagem estimado calculado usando dados de velocidade em tempo real. Incluído somente se computeTravelTimeFor = all for usado na consulta.
noTrafficTravelTimeInSeconds	integer	Tempo de viagem estimado calculado como se não houvesse atrasos no percurso devido a condições de tráfego (por exemplo, congestionamento). Incluído somente se computeTravelTimeFor = all for usado na consulta.
trafficDelayInSeconds	integer	Atraso estimado em segundos causado pelo(s) incidente(s) em tempo real de acordo com as informações de tráfego. Para rotas planejadas com horário de partida no futuro, os atrasos são sempre 0. Para retornar tempos de viagem adicionais usando diferentes tipos de informações de tráfego, o parâmetro computeTravelTimeFor=all precisa ser adicionado.
travelTimeInSeconds	integer	Propriedade de tempo de viagem estimado em segundos que inclui o atraso devido ao tráfego em tempo real. Observe que mesmo quando traffic=false travelTimeInSeconds ainda inclui o atraso devido ao tráfego. Se DepartAt for no futuro, o tempo de viagem é calculado usando dados históricos de tráfego dependentes do tempo.

RouteOptimizedWaypoint

Object

Objeto de ponto de caminho otimizado.

Name	Tipo	Description
optimizedIndex	integer	Índice de pontos de passagem otimizado do sistema.
providedIndex	integer	Índice de pontos de passagem fornecido pelo usuário.

RouteReport

Object

Relata as configurações efetivas usadas na chamada atual.

Name	Tipo	Description
effectiveSettings	EffectiveSetting[]	Parâmetros ou dados efetivos usados ao chamar essa API de rota.

RouteSection

Object

As seções de rota contêm informações adicionais sobre partes de uma rota. Cada seção contém pelo menos os elementos startPointIndex, endPointIndexe sectionType.

Name	Tipo	Description
delayInSeconds	integer	Atraso em segundos causado pelo incidente.
effectiveSpeedInKmh	integer	Velocidade efetiva do incidente em km/h, calculada em média em todo o seu comprimento.
endPointIndex	integer	Índice do último ponto (deslocamento 0) na rota à qual esta seção se aplica.
magnitudeOfDelay	DelayMagnitude	A magnitude do atraso causado pelo incidente. Esses valores correspondem aos valores do campo de resposta do Get Traffic Incident Detail API.
sectionType	ResponseSectionType	Tipos de seção da resposta de rota relatada
simpleCategory	SimpleCategory	Tipo de incidente. Atualmente pode ser JAM, ROAD_WORK, ROAD_CLOSURE ou OUTRO. Consulte "tec" para obter informações detalhadas.
startPointIndex	integer	Índice do primeiro ponto (deslocamento 0) na rota a que esta secção se aplica.
tec	RouteSectionTec	Detalhes do evento de tráfego, usando definições no TPEG2-TEC padrão. Pode conter elementos effectCode e causas.
travelMode	ResponseTravelMode	Modo de viagem para a rota calculada. O valor será definido como `other` se o modo de transporte solicitado não for possível nesta seção

RouteSectionTec

Object

Detalhes do evento de tráfego, usando definições no TPEG2-TEC padrão. Pode conter elementos effectCode e causas.

Name	Tipo	Description
causes	RouteSectionTecCause[]	Matriz de causas
effectCode	integer	O efeito no fluxo de tráfego. Contém um valor na tabela tec001:EffectCode, conforme definido no padrão TPEG2-TEC. Pode ser usado para codificar eventos de tráfego por cores de acordo com a gravidade.

RouteSectionTecCause

Object

A causa do evento de trânsito. Pode conter elementos mainCauseCode e subCauseCode. Pode ser usado para definir iconografia e descrições.

Name	Tipo	Description
mainCauseCode	integer	A principal causa do evento de trânsito. Contém um valor na tabela tec002:CauseCode, conforme definido no padrão TPEG2-TEC.
subCauseCode	integer	A subcausa do evento de tráfego. Contém um valor na tabela de subcausa definida pelo mainCauseCode, conforme definido no padrão TPEG2-TEC.

RouteSummary

Object

Objeto de resumo

Name	Tipo	Description
arrivalTime	string (date-time)	A hora prevista de chegada para o percurso ou trecho. A hora está em UTC.
departureTime	string (date-time)	A hora de partida estimada para a rota ou trecho. A hora está em UTC.
lengthInMeters	integer	Comprimento em metros propriedade
trafficDelayInSeconds	integer	Atraso estimado em segundos causado pelo(s) incidente(s) em tempo real de acordo com as informações de tráfego. Para rotas planejadas com horário de partida no futuro, os atrasos são sempre 0. Para retornar tempos de viagem adicionais usando diferentes tipos de informações de tráfego, o parâmetro computeTravelTimeFor=all precisa ser adicionado.
travelTimeInSeconds	integer	Propriedade de tempo de viagem estimado em segundos que inclui o atraso devido ao tráfego em tempo real. Observe que mesmo quando traffic=false travelTimeInSeconds ainda inclui o atraso devido ao tráfego. Se DepartAt for no futuro, o tempo de viagem é calculado usando dados históricos de tráfego dependentes do tempo.

SimpleCategory

Enumeração

Tipo de incidente. Atualmente pode ser JAM, ROAD_WORK, ROAD_CLOSURE ou OUTRO. Consulte "tec" para obter informações detalhadas.

Valor	Description
JAM	Engarrafamento.
OTHER	Outros.
ROAD_CLOSURE	Encerramento de estradas.
ROAD_WORK	Obras rodoviárias.

Summary

Object

Resumo dos resultados do pedido de lote

Name	Tipo	Description
successfulRequests	integer	Número de solicitações bem-sucedidas no lote
totalRequests	integer	Número total de solicitações no lote

Partilhar via

Route - Get Route Directions Batch

Baixar resultados de lote assíncronos

Modelo de resposta em lote

Parâmetros do URI

Cabeçalho do Pedido

Respostas

Segurança

AADToken

Observações

Âmbitos

subscription-key

SAS Token

Exemplos

Successfully retrieve the status for the route direction batch request

Pedido de amostra

Resposta da amostra

Definições

DelayMagnitude

DrivingSide

EffectiveSetting

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GuidanceInstructionType

GuidanceManeuver

JunctionType

LatLongPair

Response

ResponseSectionType

ResponseTravelMode

Route

RouteDirectionsBatchItem

RouteDirectionsBatchResult

RouteGuidance

RouteInstruction

RouteInstructionGroup

RouteLeg

RouteLegSummary

RouteOptimizedWaypoint

RouteReport

RouteSection

RouteSectionTec

RouteSectionTecCause

RouteSummary

SimpleCategory

Summary