Partilhar via

Route - Post Route Directions Batch Sync

  • Referência
Serviço:
Maps
Versão da API:
1.0

Utilize para enviar um lote de consultas para a API Obter Direções de Rota num único pedido síncrono.

A Post Route Directions Batch Sync API é um pedido HTTP POST que envia lotes de consultas para a API Get Route Directions com um único pedido síncrono. Pode chamar Route Directions Batch a API para ser executada de forma assíncrona (assíncrona) ou síncrona (sincronização). A API assíncrona permite que o autor da chamada crie um lote de até 700 consultas e sincronize a API até 100 consultas. Para chamar a Post Route Directions Batch API num pedido assíncrono, veja Post Route Directions Batch (Post Route Directions Batch).

Submeter Pedido do Batch Síncrono

A API Síncrona é recomendada para pedidos em lote simples. Quando o serviço receber um pedido, este responderá assim que os itens do lote forem calculados e não haverá possibilidade de obter os resultados mais tarde. A API Síncrona devolverá um erro de tempo limite (uma resposta 408) se o pedido demorar mais de 60 segundos. O número de itens de lote está limitado a 100 para esta API.

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

Modelo de Resposta do Batch

O conteúdo de dados devolvido é semelhante para pedidos de sincronização e assíncrona. Ao transferir os resultados de um pedido de lote assíncrono, se o lote tiver terminado o processamento, o corpo da resposta contém a resposta do lote. Esta resposta em lote contém um summary componente que indica o totalRequests que fazia parte do pedido de lote original e successfulRequests, por exemplo, consultas que foram executadas com êxito. A resposta em lote também inclui uma batchItems matriz que contém uma resposta para cada consulta no pedido batch. O batchItems irá conter os resultados na mesma ordem em que as consultas originais foram enviadas no pedido batch. Cada item em batchItems contém statusCode e response campos. Cada response um deles batchItems é de um dos seguintes tipos:

  • RouteDirections - Se a consulta tiver sido concluída com êxito.

  • Error - Se a consulta tiver falhado. A resposta conterá um code e um message neste caso.

Eis um exemplo de Resposta do Batch com 1 resultado com êxito e 1 com falha :

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

POST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0

Parâmetros do URI

Name Em Necessário Tipo Description
format
 path True

JsonFormat

Formato pretendido da resposta. Apenas json o formato é suportado.
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 a conta que se destina à utilização em conjunto com o modelo de segurança Microsoft Entra ID. Representa um ID exclusivo para a conta do Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão do Azure Maps. Para utilizar a segurança do Microsoft Entra ID no Azure Maps, consulte os seguintes artigos para obter orientações.

Corpo do Pedido

Name Tipo Description
batchItems

BatchRequestItem[]

A lista de consultas a processar.

Respostas

Name Tipo Description
200 OK

RouteDirectionsBatchResult

OK
Other Status Codes

ErrorResponse

Tempo limite: o pedido demorou mais tempo a ser concluído do que o período máximo de tempo definido na api.
Other Status Codes

ErrorResponse

Ocorreu um erro inesperado.

Segurança

AADToken

Estes são os Fluxos microsoft Entra OAuth 2.0 . Quando emparelhado com o controlo de acesso baseado em funções do Azure , pode ser utilizado para controlar o acesso às APIs REST do Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais contas de recursos ou sub-recursos do Azure Maps. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para as APIs REST do Azure Maps.

Para implementar cenários, recomendamos que veja os conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações através de objetos com capacidade de controlo de acesso em APIs e âmbitos específicos.

Notas

  • Esta definição de segurança requer a utilização do x-ms-client-id cabeçalho para indicar a que recurso do Azure Maps a aplicação está a pedir acesso. Isto pode ser adquirido na API de gestão de Mapas.

O Authorization URL é específico da instância da cloud pública do Azure. As clouds soberanas têm URLs de Autorização exclusivos e configurações do Microsoft Entra ID. * O controlo de acesso baseado em funções do Azure está configurado a partir do plano de gestão do Azure através do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST. * A utilização do SDK Web do Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.

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 partilhada que é aprovisionada quando cria uma conta do Azure Maps no portal do Azure ou utiliza o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com esta chave, qualquer aplicação pode aceder a toda a API REST. Por outras palavras, esta chave pode ser utilizada como uma chave mestra na conta na qual são emitidas.

Para aplicações expostas publicamente, a nossa recomendação é utilizar a abordagem de aplicações cliente confidenciais para aceder às APIs REST do Azure Maps para que a sua chave possa ser armazenada de forma segura.

Tipo: apiKey
Em: query

SAS Token

Este é um token de assinatura de acesso partilhado criado a partir da operação List SAS no recurso do Azure Maps através do plano de gestão do Azure através do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.

Com este token, qualquer aplicação está autorizada a aceder com controlos de acesso baseados em funções do Azure e controlo detalhado para a expiração, taxa e regiões de utilização para o token específico. Por outras palavras, o Token de SAS pode ser utilizado para permitir que as aplicações controlem o acesso de uma forma mais segura do que a chave partilhada.

Para aplicações expostas publicamente, a nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta de Mapa para limitar o abuso de composição e renovar regularmente o Token de SAS.

Tipo: apiKey
Em: header

Exemplos

Successfully retrieve the route direction batch result synchronously

Pedido de amostra

POST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0

{
  "batchItems": [
    {
      "query": "?query=47.639987,-122.128384:47.621252,-122.184408:47.596437,-122.332000&routeType=fastest&travelMode=car&maxAlternatives=99"
    },
    {
      "query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false"
    },
    {
      "query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest"
    }
  ]
}

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:
408 
{
  "error": {
    "code": "408 Timeout",
    "message": "Timeout: The request took longer to finish than the maximum amount of time defined in the api."
  }
}

Definições

Name Description
BatchRequest

Este tipo representa o corpo do pedido para o serviço Batch.
BatchRequestItem

Objeto de pedido do Batch
DelayMagnitude

A magnitude do atraso causado pelo incidente. Estes valores correspondem aos valores do campo de resposta da API Obter Detalhes do Incidente de Tráfego.
DrivingSide

Indica a condução do lado esquerdo vs. do lado direito no ponto da manobra.
EffectiveSetting

Parâmetro ou dados eficazes utilizados ao chamar esta API de Rota.
ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta a erros
GuidanceInstructionType

Tipo de instrução, por exemplo, virar ou alterar o formulário de estrada.
GuidanceManeuver

Um código que identifica a manobra.
JsonFormat

Formato pretendido da resposta. Apenas json o formato é suportado.
JunctionType

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

Uma localização representada como uma latitude e longitude.
Response

O resultado da consulta. RouteDirections se a consulta tiver sido concluída com êxito, ErroResponse caso contrário.
ResponseSectionType

Tipos de secção da resposta de rota reportada
ResponseTravelMode

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

Um item devolvido da chamada do serviço Route Directions Batch.
RouteDirectionsBatchResult

Este objeto é devolvido a partir de uma chamada de serviço do Batch Route Directions bem-sucedida.
RouteGuidance

Contém elementos relacionados com a documentação de orientação. Este campo só está presente quando a documentação de orientação foi pedida e está disponível.
RouteInstruction

Um conjunto de atributos que descreve uma manobra, por exemplo, "Virar à direita", "Manter à esquerda", "Apanhar o ferry", "Tomar a auto-estrada", "Chegar".
RouteInstructionGroup

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

Uma descrição de uma parte de uma rota, composta por uma lista de pontos. Cada ponto de passagem adicional fornecido no pedido resultará numa perna adicional na rota devolvida.
RouteLegSummary

Objeto de resumo para a secção de rota.
RouteOptimizedWaypoint

Objeto de ponto de caminho otimizado.
RouteReport

Comunica as definições efetivas utilizadas na chamada atual.
RouteSection

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

Detalhes do evento de tráfego, com definições na norma TPEG2-TEC . Pode conter effectCode e causar elementos.
RouteSectionTecCause

A causa do evento de tráfego. Pode conter elementos mainCauseCode e subCauseCode. Pode ser utilizado para definir iconografia e descrições.
RouteSummary

Objeto de resumo
SimpleCategory

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

Resumo dos resultados do pedido do batch

BatchRequest

Este tipo representa o corpo do pedido para o serviço Batch.

Name Tipo Description
batchItems

BatchRequestItem[]

A lista de consultas a processar.

BatchRequestItem

Objeto de pedido do Batch

Name Tipo Description
query

string

Este parâmetro contém uma cadeia de consulta utilizada para executar uma operação de geocodificação não estruturada. A cadeia de consulta será transmitida literalmente à API de pesquisa para processamento.

DelayMagnitude

A magnitude do atraso causado pelo incidente. Estes valores correspondem aos valores do campo de resposta da API Obter Detalhes do Incidente de Tráfego.

Name Tipo Description
0

string

Desconhecido.
1

string

Menor.
2

string

Moderado.
3

string

Major.
4

string

Indefinido, utilizado para encerramentos de estradas e outros atrasos indefinidos.

DrivingSide

Indica a condução do lado esquerdo vs. do lado direito no ponto da manobra.

Name Tipo Description
LEFT

string

Lado esquerdo.
RIGHT

string

Lado direito.

EffectiveSetting

Parâmetro ou dados eficazes utilizados ao chamar esta API de Rota.

Name Tipo Description
key

string

Nome do parâmetro utilizado.
value

string

Valor do parâmetro utilizado.

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

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

ErrorResponse

Resposta a erros

Name Tipo Description
error

ErrorDetail

O objeto de erro.

GuidanceInstructionType

Tipo de instrução, por exemplo, virar ou alterar o formulário de estrada.

Name Tipo Description
DIRECTION_INFO

string

Informações de direção.
LOCATION_ARRIVAL

string

Localização da chegada.
LOCATION_DEPARTURE

string

Localização da partida.
LOCATION_WAYPOINT

string

Localização do ponto de passagem.
ROAD_CHANGE

string

Mudança de Estrada.
TURN

string

Vire- se.

GuidanceManeuver

Um código que identifica a manobra.

Name Tipo Description
ARRIVE

string

Chegou.
ARRIVE_LEFT

string

Chegou. O seu destino é à esquerda.
ARRIVE_RIGHT

string

Chegou. O seu destino está à direita.
BEAR_LEFT

string

Urso à esquerda.
BEAR_RIGHT

string

Urso à direita.
DEPART

string

Vai embora.
ENTER_FREEWAY

string

Pegue a auto-estrada.
ENTER_HIGHWAY

string

Pegue a auto-estrada.
ENTER_MOTORWAY

string

Pegue a auto-estrada.
ENTRANCE_RAMP

string

Pegue a rampa.
FOLLOW

string

Siga- o.
KEEP_LEFT

string

Mantenha-se à esquerda.
KEEP_RIGHT

string

Mantenha-se à direita.
MAKE_UTURN

string

Faça uma inversão de marcha.
MOTORWAY_EXIT_LEFT

string

Pegue a saída à esquerda.
MOTORWAY_EXIT_RIGHT

string

Faça a saída à direita.
ROUNDABOUT_BACK

string

Dar a volta à rotunda.
ROUNDABOUT_CROSS

string

Atravessem a rotunda.
ROUNDABOUT_LEFT

string

Na rotunda, pegue a saída à esquerda.
ROUNDABOUT_RIGHT

string

Na rotunda, pegue a saída à direita.
SHARP_LEFT

string

Vire para a esquerda.
SHARP_RIGHT

string

Vire para a direita.
STRAIGHT

string

Mantenha-se direto.
SWITCH_MAIN_ROAD

string

Mude para a estrada principal.
SWITCH_PARALLEL_ROAD

string

Mude para a estrada paralela.
TAKE_EXIT

string

Pegue a saída.
TAKE_FERRY

string

Pegue o ferry.
TRY_MAKE_UTURN

string

Tente fazer uma inversão de marcha.
TURN_LEFT

string

Vire para a esquerda.
TURN_RIGHT

string

Vire à direita.
WAYPOINT_LEFT

string

Chegou ao ponto de passagem. É à esquerda.
WAYPOINT_REACHED

string

Chegou ao ponto de passagem.
WAYPOINT_RIGHT

string

Chegou ao ponto de passagem. É à direita.

JsonFormat

Formato pretendido da resposta. Apenas json o formato é suportado.

Name Tipo Description
json

string

O Formato de Intercâmbio de Dados de Notação de Objetos JavaScript

JunctionType

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

Name Tipo Description
BIFURCATION

string

bifurcação
REGULAR

string

regular
ROUNDABOUT

string

rotunda

LatLongPair

Uma localização representada como uma latitude e longitude.

Name Tipo Description
latitude

number

Propriedade Latitude
longitude

number

Propriedade Longitude

Response

O resultado da consulta. RouteDirections se a consulta tiver sido concluída com êxito, ErroResponse caso contrário.

Name Tipo Description
error

ErrorDetail

O objeto de erro.
formatVersion

string

Propriedade Formatar Versão
optimizedWaypoints

RouteOptimizedWaypoint[]

Sequência otimizada de pontos de passagem. Mostra o índice da sequência de waypoint fornecida pelo utilizador 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]. Uma vez que o índice começa por 0, o original é "primeiro, segundo, terceiro" enquanto o otimizado é "segundo, terceiro, primeiro".
report

RouteReport

Comunica as definições efetivas utilizadas na chamada atual.
routes

Route[]

Matriz de rotas

ResponseSectionType

Tipos de secção da resposta de rota reportada

Name Tipo Description
CARPOOL

string

Secções da rota que requerem a utilização de pistas de caráter de boleia (HOV/Veículo de Alta Ocupação).
CAR_TRAIN

string

Secções da rota que são carros ou comboios.
COUNTRY

string

Secções que indicam em que países/regiões se encontra a rota.
FERRY

string

Secções da rota que são ferries.
MOTORWAY

string

Secções da rota que são auto-estradas.
PEDESTRIAN

string

Secções do percurso que são apenas adequadas para peões.
TOLL_ROAD

string

Secções da rota que exigem o pagamento de uma portagem.
TOLL_VIGNETTE

string

Secções da rota que requerem uma vinheta de portagem para estar presente.
TRAFFIC

string

Secções da rota que contêm informações de tráfego.
TRAVEL_MODE

string

Secções em relação ao parâmetro travelModede pedido .
TUNNEL

string

Secções da rota que são túneis.
URBAN

string

Secções da rota localizadas em áreas urbanas.

ResponseTravelMode

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

Name Tipo Description
bicycle

string

As rotas devolvidas são otimizadas para bicicletas, incluindo a utilização de ciclovias.
bus

string

As rotas devolvidas são otimizadas para autocarros, incluindo a utilização de faixas apenas de autocarro. Funcionalidade BETA.
car

string

As rotas devolvidas estão otimizadas para automóveis.
motorcycle

string

As rotas devolvidas são otimizadas para motociclos. Funcionalidade BETA.
other

string

O modo de transporte especificado não é possível nesta secção
pedestrian

string

As rotas devolvidas são otimizadas para peões, incluindo a utilização de calçadas.
taxi

string

As rotas devolvidas são otimizadas para táxis. Funcionalidade BETA.
truck

string

As rotas devolvidas são otimizadas para veículos comerciais, como para camiões.
van

string

As rotas devolvidas estão otimizadas para carrinhas. Funcionalidade BETA.

Route

Name Tipo Description
guidance

RouteGuidance

Contém elementos relacionados com a documentação de orientação. Este campo só está presente quando a documentação de orientação foi pedida e está disponível.
legs

RouteLeg[]

Matriz de pernas
sections

RouteSection[]

Matriz de secções
summary

RouteSummary

Objeto de resumo

RouteDirectionsBatchItem

Um item devolvido da chamada do serviço Route Directions Batch.

Name Tipo Description
response

Response

O resultado da consulta. RouteDirections se a consulta tiver sido concluída com êxito, ErroResponse caso contrário.
statusCode

integer

Código de estado do pedido HTTP.

RouteDirectionsBatchResult

Este objeto é devolvido a partir de uma chamada de serviço do Batch Route Directions bem-sucedida.

Name Tipo Description
batchItems

RouteDirectionsBatchItem[]

Matriz que contém os resultados do lote.
summary

Summary

Resumo dos resultados do pedido do batch

RouteGuidance

Contém elementos relacionados com a documentação de orientação. Este campo só está presente quando a documentação de orientação foi pedida 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 que descrevem manobras.

RouteInstruction

Um conjunto de atributos que descreve uma manobra, por exemplo, "Virar à direita", "Manter à esquerda", "Apanhar o ferry", "Tomar a auto-estrada", "Chegar".

Name Tipo Description
combinedMessage

string

Uma mensagem legível por humanos para a manobra combinada com a mensagem da instrução seguinte. Por vezes, é possível combinar duas instruções sucessivas numa única instrução, tornando mais fácil segui-la. Quando for este o caso, o sinalizador possibleCombineWithNext será verdadeiro. 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 é verdadeiro. Isto indica aos clientes de orientação codificada que pode ser combinado com a instrução 11. As instruções serão combinadas automaticamente para clientes que solicitem orientações legíveis 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

Código de país ISO 3166-1 alfa-3 de 3 carateres. Por exemplo, EUA.
drivingSide

DrivingSide

Indica a condução do lado esquerdo vs. direito no ponto da manobra.
exitNumber

string

O número de uma saída rodoviária tomada pela manobra atual. Se uma saída tiver vários números de saída, estes serão separados por "" e possivelmente agregados por "-", por exemplo, "10, 13-15".
instructionType

GuidanceInstructionType

Tipo de instrução, por exemplo, virar ou alterar o formulário de estrada.
junctionType

JunctionType

O tipo de junção 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

Uma localização representada como uma latitude e longitude.
pointIndex

integer

O índice do ponto na lista de "pontos" poliline correspondente ao ponto da instrução.
possibleCombineWithNext

boolean

Opcionalmente, é possível combinar a instrução com a seguinte. Isto pode ser utilizado para criar mensagens como "Virar para a esquerda e, em seguida, virar para a direita".
roadNumbers

string[]

O(s) número(s) de estrada(s) do(s) próximo(s) segmento(s) de estrada(s) significativo(s) após a manobra, ou das estradas a seguir. Exemplo: ["E34", "N205"]
roundaboutExitNumber

integer

Isto indica que saída deve ser tomada numa rotunda.
routeOffsetInMeters

integer

Distância desde o início da rota até ao ponto da instrução.
signpostText

string

O texto numa placa 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 . Esta opção só está disponível para alguns países/regiões, como os EUA, o Canadá e o México.
street

string

Nome da rua do próximo segmento de estrada significativo após a manobra, ou da rua que deve ser seguida.
travelTimeInSeconds

integer

Tempo estimado de deslocação até ao ponto correspondente a routeOffsetInMeters.
turnAngleInDecimalDegrees

integer

Indica a direção de uma instrução. Se junctionType indicar uma instrução de viragem:

  • 180 = U-turn
  • [-179, -1] = Curva para a esquerda
  • 0 = Ativado diretamente (uma curva de 0 graus)
  • [1, 179] = Curva à direita

Se junctionType indicar uma instrução de bifurcação:

  • <0 - manter à esquerda
  • >0 - manter à direita

RouteInstructionGroup

Agrupa uma sequência de elementos de instrução que estão relacionados entre si. O intervalo de sequência está restrito com firstInstructionIndex e lastInstructionIndex. Quando são pedidas mensagens de texto legíveis por humanos para orientação (instructionType=texto ou etiquetada), o instructionGroup tem uma mensagem de resumo devolvida 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 são pedidas mensagens de texto legíveis por humanos para orientação (instructionType=texto ou etiquetado).
lastInstructionIndex

integer

Índice da última instrução nas instruções e pertencente a este grupo.

RouteLeg

Uma descrição de uma parte de uma rota, composta por uma lista de pontos. Cada ponto de passagem adicional fornecido no pedido resultará numa perna adicional na rota devolvida.

Name Tipo Description
points

LatLongPair[]

Matriz de pontos
summary

RouteLegSummary

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

RouteLegSummary

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

Name Tipo Description
arrivalTime

string

A hora de chegada estimada para a rota ou perna. A hora é em UTC.
batteryConsumptionInkWh

number

Estimativa do consumo de energia elétrica em kilowatt horas (kWh) com o Modelo de Consumo Elétrico. Incluído se vehicleEngineType estiver definido como elétrico e constantSpeedConsumptionInkWhPerHundredkm for especificado. O valor de batteryConsumptionInkWh inclui a energia elétrica recuperada e, portanto, pode ser negativo (o que indica a obtenção de energia). Se estiverem especificados maxChargeInkWh e currentChargeInkWh, a recuperação será limitada para garantir que o nível de carga da bateria nunca excede maxChargeInkWh. Se não forem especificados maxChargeInkWh nem currentChargeInkWh, é assumida uma recuperação sem restrições no cálculo do consumo.
departureTime

string

A hora de partida estimada para a rota ou perna. A hora é em UTC.
fuelConsumptionInLiters

number

Consumo estimado de combustível em litros com o Modelo de Consumo de Combustão. Incluído se vehicleEngineType estiver definido como combustão e constantSpeedConsumptionInLitersPerHundredkm for especificado. O valor não será negativo.
historicTrafficTravelTimeInSeconds

integer

Tempo de viagem estimado calculado com dados de tráfego histórico dependentes do tempo. Incluído apenas se computeTravelTimeFor = todos forem utilizados na consulta.
lengthInMeters

integer

Propriedade Comprimento em Medidores
liveTrafficIncidentsTravelTimeInSeconds

integer

Tempo de viagem estimado calculado com dados de velocidade em tempo real. Incluído apenas se computeTravelTimeFor = todos forem utilizados na consulta.
noTrafficTravelTimeInSeconds

integer

O tempo estimado de deslocação foi calculado como se não existissem atrasos na rota devido às condições de tráfego (por exemplo, congestionamento). Incluído apenas se computeTravelTimeFor = todos forem utilizados na consulta.
trafficDelayInSeconds

integer

Atraso estimado em segundos causado pelos incidentes em tempo real, de acordo com as informações de tráfego. Para rotas planeadas com a hora de partida no futuro, os atrasos são sempre 0. Para devolver tempos de viagem adicionais com diferentes tipos de informações de tráfego, a computação de parâmetrosTravelTimeFor=todos tem de ser adicionado.
travelTimeInSeconds

integer

Propriedade tempo de viagem estimado em segundos que inclui o atraso devido ao tráfego em tempo real. Tenha em atenção que mesmo quando o tráfego=false travelTimeInSeconds ainda inclui o atraso devido ao tráfego. Se DepartAt estiver no futuro, o tempo de viagem é calculado com dados de tráfego histórico dependentes do tempo.

RouteOptimizedWaypoint

Objeto de ponto de caminho otimizado.

Name Tipo Description
optimizedIndex

integer

Índice de pontos de forma otimizado do sistema.
providedIndex

integer

Índice de ponto de caminho fornecido pelo utilizador.

RouteReport

Comunica as definições efetivas utilizadas na chamada atual.

Name Tipo Description
effectiveSettings

EffectiveSetting[]

Parâmetros ou dados eficazes utilizados ao chamar esta API de Rota.

RouteSection

As secções de rota contêm informações adicionais sobre partes de uma rota. Cada secçã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, média acima de todo o comprimento.
endPointIndex

integer

Índice do último ponto (desvio 0) na rota a que esta secção se aplica.
magnitudeOfDelay

DelayMagnitude

A magnitude do atraso causado pelo incidente. Estes valores correspondem aos valores do campo de resposta da API Obter Detalhes do Incidente de Tráfego.
sectionType

ResponseSectionType

Tipos de secção da resposta de rota reportada
simpleCategory

SimpleCategory

Tipo do incidente. Atualmente, pode ser JAM, ROAD_WORK, ROAD_CLOSURE ou OTHER. Veja "tec" para obter informações detalhadas.
startPointIndex

integer

Índice do primeiro ponto (desvio 0) na rota a que esta secção se aplica.
tec

RouteSectionTec

Detalhes do evento de tráfego, utilizando definições na norma TPEG2-TEC . Pode conter effectCode e causar elementos.
travelMode

ResponseTravelMode

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

RouteSectionTec

Detalhes do evento de tráfego, com definições na norma TPEG2-TEC . Pode conter effectCode e causar elementos.

Name Tipo Description
causes

RouteSectionTecCause[]

Causa matriz
effectCode

integer

O efeito no fluxo de tráfego. Contém um valor na tabela tec001:EffectCode, conforme definido na norma TPEG2-TEC . Pode ser utilizado para colorir eventos de tráfego de acordo com a gravidade.

RouteSectionTecCause

A causa do evento de tráfego. Pode conter elementos mainCauseCode e subCauseCode. Pode ser utilizado para definir iconografia e descrições.

Name Tipo Description
mainCauseCode

integer

A principal causa do evento de tráfego. Contém um valor na tabela tec002:CauseCode, conforme definido na norma TPEG2-TEC .
subCauseCode

integer

A subcautilidade do evento de tráfego. Contém um valor na tabela de sub-causa definida pelo mainCauseCode, conforme definido na norma TPEG2-TEC .

RouteSummary

Objeto de resumo

Name Tipo Description
arrivalTime

string

A hora de chegada estimada para a rota ou perna. O tempo está em UTC.
departureTime

string

A hora de partida estimada para a rota ou perna. O tempo está em UTC.
lengthInMeters

integer

Propriedade Comprimento em Medidores
trafficDelayInSeconds

integer

Atraso estimado em segundos causado pelos incidentes em tempo real, de acordo com as informações de tráfego. Para rotas planeadas com a hora de partida no futuro, os atrasos são sempre 0. Para devolver tempos de viagem adicionais com diferentes tipos de informações de tráfego, a computação de parâmetrosTravelTimeFor=todos tem de ser adicionado.
travelTimeInSeconds

integer

Propriedade tempo de viagem estimado em segundos que inclui o atraso devido ao tráfego em tempo real. Tenha em atenção que mesmo quando o tráfego=false travelTimeInSeconds ainda inclui o atraso devido ao tráfego. Se DepartAt estiver no futuro, o tempo de viagem é calculado com dados de tráfego histórico dependentes do tempo.

SimpleCategory

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

Name Tipo Description
JAM

string

Engarrafamento.
OTHER

string

Outro.
ROAD_CLOSURE

string

Encerramento da estrada.
ROAD_WORK

string

Trabalho de estrada.

Summary

Resumo dos resultados do pedido do batch

Name Tipo Description
successfulRequests

integer

Número de pedidos bem-sucedidos no lote
totalRequests

integer

Número total de pedidos no lote