Route - Post Route Matrix

Referência

Service:: Maps

API Version:: 1.0

Utilize para obter uma matriz de rotas que mostre o tempo de viagem e a distância de todos os pares possíveis numa lista de origens e destinos, utilizando um pedido assíncrono.

A Post Route Matrix API é um pedido HTTP POST que permite o cálculo de uma matriz de resumos de rotas para um conjunto de rotas definidas por localizações de origem e destino através de um pedido assíncrono (assíncrono). Para fazer um pedido síncrono (sincronização), veja Sincronização de Matriz pós-rota. Para cada origem, o serviço calcula o custo do encaminhamento dessa origem para cada destino especificado. O conjunto de origens e o conjunto de destinos podem ser considerados como os cabeçalhos de coluna e linha de uma tabela e cada célula na tabela contém os custos de encaminhamento da origem para o destino dessa célula. Por exemplo, digamos que uma empresa de entrega de alimentos tem 20 motoristas e precisa de encontrar o motorista mais próximo para pegar a entrega no restaurante. Para resolver este caso de utilização, podem chamar a API de Rota de Matriz.

Para cada rota, os tempos de viagem e as distâncias são devolvidos. Pode utilizar os custos calculados para determinar quais as rotas detalhadas a calcular com a API De Direções de Rotas.

O tamanho máximo de uma matriz para pedido assíncrono é 700 e para pedido de sincronização é 100 (o número de origens multiplicado pelo número de destinos).

Submeter Pedido de Matriz de Rota síncrona

Se o seu cenário exigir pedidos síncronos e o tamanho máximo da matriz for inferior ou igual a 100, poderá querer fazer um pedido síncrono. O tamanho máximo de uma matriz para esta API é 100 (o número de origens multiplicado pelo número de destinos). Com essa restrição em mente, os exemplos de dimensões de matriz possíveis são: 10x10, 6x8, 9x8 (não precisa de ser quadrado).

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

Submeter Pedido de Matriz de Rotas Assíncrona

A API Assíncrona é adequada para processar grandes volumes de pedidos de encaminhamento relativamente complexos. Quando faz um pedido com o pedido assíncrono, por predefinição, o serviço devolve um código de resposta 202 ao longo de um URL de redirecionamento no campo Localização do cabeçalho de resposta. Este URL deve ser verificado periodicamente até que os dados de resposta ou as informações de erro estejam disponíveis. Se waitForResults o parâmetro no pedido estiver definido como verdadeiro, o utilizador obterá uma resposta de 200 se o pedido for concluído em menos de 120 segundos.

O tamanho máximo de uma matriz para esta API é 700 (o número de origens multiplicado pelo número de destinos). Com essa restrição em mente, são exemplos de dimensões de matriz possíveis: 50x10, 10x10, 28x25. 10x70 (não tem de ser quadrado).

As respostas assíncronas são armazenadas durante 14 dias. O URL de redirecionamento devolve uma resposta 404 se for utilizado após o período de expiração.

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

Eis uma sequência típica de operações assíncronas:

O cliente envia um pedido POST de Matriz de Rota para Azure Maps
O servidor responderá com um dos seguintes procedimentos:

HTTP 202 Accepted – O pedido de Matriz de Rotas foi aceite.

HTTP Error – Ocorreu um erro ao processar o pedido da Matriz de Rotas. Pode ser um Pedido Incorreto 400 ou qualquer outro código de estado de erro.
Se o pedido de Rota de Matriz tiver sido aceite com êxito, o cabeçalho Localização na resposta contém o URL para transferir os resultados do pedido. Este URI de estado tem o seguinte aspeto:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

O cliente emite um pedido GET no URL de transferência obtido no Passo 3 para transferir os resultados

Transferir Resultados da Sincronização

Quando faz um pedido POST para a API de Sincronização de Matriz de Rotas, o serviço devolve o código de resposta 200 para um pedido com êxito e uma matriz de resposta. O corpo da resposta irá conter os dados e não haverá possibilidade de obter os resultados mais tarde.

Transferir Resultados assíncronos

Quando um pedido emite uma 202 Accepted resposta, o pedido está a ser processado com o nosso pipeline assíncrono. Receberá um URL para verificar o progresso do seu pedido assíncrono no cabeçalho de localização da resposta. Este URI de estado tem o seguinte aspeto:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

O URL fornecido pelo cabeçalho de localização devolverá as seguintes respostas quando um GET pedido for emitido.

HTTP 202 Accepted – O pedido de matriz foi aceite, mas ainda está a ser processado. Tente novamente dentro de algum tempo.

HTTP 200 OK – Pedido de matriz processado com êxito. O corpo da resposta contém todos os resultados.

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

With optional parameters:

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&waitForResults={waitForResults}&computeTravelTimeFor={computeTravelTimeFor}&sectionType={sectionType}&arriveAt={arriveAt}&departAt={departAt}&vehicleAxleWeight={vehicleAxleWeight}&vehicleLength={vehicleLength}&vehicleHeight={vehicleHeight}&vehicleWidth={vehicleWidth}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&windingness={windingness}&hilliness={hilliness}&travelMode={travelMode}&avoid={avoid}&traffic={traffic}&routeType={routeType}&vehicleLoadType={vehicleLoadType}

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 Azure Maps.
arriveAt	query		string date-time	A data e hora de chegada no ponto de destino formatado como um `dateTime` valor conforme definido em RFC 3339, secção 5.6, com um desvio de fuso horário opcional. Quando um desvio de fuso horário não for especificado, assume-se que é o do ponto de destino. Exemplos: 2023-12-19T16:39:57 2023-12-20T00:39:57+00:00 O `arriveAt` parâmetro não pode ser utilizado em conjunto com `departAt`, `minDeviationDistance` ou `minDeviationTime`.
avoid	query		RouteAvoidType[]	Especifica algo que o cálculo da rota deve tentar evitar ao determinar a rota. Pode ser especificado várias vezes num pedido, por exemplo, "&avoid=motorways&avoid=tollRoads&avoid=ferries". Nos pedidos do Intervalo de Rotas, o valor jáUsedRoads não pode ser utilizado.
computeTravelTimeFor	query		ComputeTravelTime	Especifica se pretende devolver tempos de viagem adicionais utilizando diferentes tipos de informações de tráfego (nenhum, histórico, em direto), bem como o tempo de viagem predefinido de melhor estimativa.
departAt	query		string date-time	A data e hora de partida do ponto de origem formatada como um `dateTime` valor conforme definido em RFC 3339, secção 5.6, com um desvio opcional do fuso horário. Quando um desvio de fuso horário não é especificado, assume-se que é o do ponto de origem. Valor predefinido: agora Outro valor: `dateTime` Exemplos: 2023-12-19T16:39:57 2023-12-20T00:39:57+00:00 O `departAt` parâmetro não pode ser utilizado em conjunto com `arriveAt`.
hilliness	query		InclineLevel	Grau de colina para uma rota emocionante. Este parâmetro só pode ser utilizado em conjunto com `routeType`=emocionante.
routeType	query		RouteType	O tipo de rota pedida.
sectionType	query		SectionType	Especifica qual dos tipos de secção é comunicado na resposta da rota. Por exemplo, se sectionType = peões, as secções adequadas apenas para peões são devolvidas. Podem ser utilizados vários tipos. O sectionType predefinido refere-se à entrada travelMode. Por predefinição, travelMode está definido como carro
traffic	query		boolean	Valores possíveis: true - Considere todas as informações de tráfego disponíveis durante o encaminhamento false - Ignore os dados de tráfego atuais durante o encaminhamento. Tenha em atenção que, embora os dados de tráfego atuais sejam ignorados durante o encaminhamento, o efeito do tráfego histórico em velocidades de estrada eficazes continua a ser incorporado.
travelMode	query		TravelMode	O modo de viagem para a rota pedida. Se não estiver definido, a predefinição é "carro". Tenha em atenção que o travelMode pedido pode não estar disponível para toda a rota. Quando o travelMode pedido não estiver disponível para uma secção específica, o elemento travelMode da resposta para essa secção será "outro". Tenha em atenção que os modos de viagem de ônibus, motociclo, táxi e van são funcionalidades BETA. Os dados de restrição total não estão disponíveis em todas as áreas.
vehicleAxleWeight	query		integer	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.
vehicleHeight	query		number double	Altura do veículo em metros. Um valor de 0 significa que as restrições de altura não são consideradas.
vehicleLength	query		number double	Comprimento do veículo em metros. Um valor de 0 significa que as restrições de comprimento não são consideradas.
vehicleLoadType	query		VehicleLoadType	Tipos de carga que podem ser classificados como materiais perigosos e restringidos a algumas estradas. Os valores de vehicleLoadType disponíveis são classes Hazmat dos EUA de 1 a 9, além de classificações genéricas para utilização noutros países/regiões. Os valores que começam com USHazmat destinam-se ao encaminhamento dos EUA, enquanto outrosHazmat devem ser utilizados para todos os outros países/regiões. vehicleLoadType pode ser especificado várias vezes. Este parâmetro é atualmente considerado apenas para travelMode=truck.
vehicleMaxSpeed	query		integer	Velocidade máxima do veículo em km/hora. A velocidade máxima no perfil do veículo é utilizada para verificar se um veículo é permitido nas auto-estradas. Um valor de 0 significa que um valor adequado para o veículo será determinado e aplicado durante o planeamento da rota. Um valor não zero pode ser substituído durante o planeamento de rotas. Por exemplo, o fluxo de tráfego atual é de 60 km/hora. Se a velocidade máxima do veículo estiver definida como 50 km/hora, o motor de encaminhamento considerará 60 km/hora, uma vez que esta é a situação atual. Se a velocidade máxima do veículo for fornecida como 80 km/hora, mas o fluxo de tráfego atual for de 60 km/hora, o motor de encaminhamento voltará a utilizar 60 km/hora.
vehicleWeight	query		integer	Peso do veículo em quilogramas.
vehicleWidth	query		number double	Largura do veículo em metros. Um valor de 0 significa que as restrições de largura não são consideradas.
waitForResults	query		boolean	Booleano para indicar se deve executar o pedido de forma síncrona. Se estiver definido como verdadeiro, o utilizador obterá uma resposta 200 se o pedido for concluído em menos de 120 segundos. Caso contrário, o utilizador receberá imediatamente uma resposta 202. Veja a descrição da API para obter mais detalhes sobre a resposta 202. Suportado apenas para pedido assíncrono.
windingness	query		WindingnessLevel	Nível de voltas para uma rota emocionante. Este parâmetro só pode ser utilizado em conjunto com `routeType`=emocionante.

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 Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão Azure Maps. Para utilizar Microsoft Entra ID segurança no Azure Maps veja os seguintes artigos para obter orientações.

Corpo do Pedido

Name	Tipo	Description
destinations	GeoJsonMultiPoint	Um tipo de geometria válido `GeoJSON MultiPoint` . Consulte RFC 7946 para obter detalhes.
origins	GeoJsonMultiPoint	Um tipo de geometria válido `GeoJSON MultiPoint` . Consulte RFC 7946 para obter detalhes.

Respostas

Name	Tipo	Description
200 OK	RouteMatrixResult	Pedido de matriz processado com êxito. O corpo da resposta contém todos os resultados.
202 Accepted		Suportado apenas para pedido assíncrono. Pedido Aceite: o pedido foi aceite para processamento. Utilize o URL no Cabeçalho de Localização para repetir ou aceder aos resultados. Headers Location: string
Other Status Codes	ErrorResponse	Ocorreu um erro inesperado.

Name

Tipo

Description

200 OK

RouteMatrixResult

Pedido de matriz processado com êxito. O corpo da resposta contém todos os resultados.

202 Accepted

Suportado apenas para pedido assíncrono. Pedido Aceite: o pedido foi aceite para processamento. Utilize o URL no Cabeçalho de Localização para repetir ou aceder aos resultados.

Headers

Location: string

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 Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais Azure Maps conta de recursos ou sub-recursos. 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 Azure Maps APIs REST.

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 Azure Maps recurso a que 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 de 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 de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * A utilização do SDK Web Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.

Para obter mais informações sobre plataforma de identidades da Microsoft, consulte plataforma de identidades da Microsoft descrição geral.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

subscription-key

Esta é uma chave partilhada que é aprovisionada quando Create uma conta Azure Maps no portal do Azure ou com 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 Azure Maps APIs REST para que a sua chave possa ser armazenada de forma segura.

Type: apiKey
In: query

SAS Token

Este é um token de assinatura de acesso partilhado criado a partir da operação List SAS no recurso de Azure Maps através do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou 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.

Type: apiKey
In: header

Exemplos

Successfully submit a route matrix request

Sample Request

HTTP

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&routeType=shortest

{
  "origins": {
    "type": "MultiPoint",
    "coordinates": [
      [
        4.85106,
        52.36006
      ],
      [
        4.85056,
        52.36187
      ]
    ]
  },
  "destinations": {
    "type": "MultiPoint",
    "coordinates": [
      [
        4.85003,
        52.36241
      ],
      [
        13.42937,
        52.50931
      ]
    ]
  }
}

Sample Response

Status code:: 200

{
  "formatVersion": "0.0.1",
  "matrix": [
    [
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 495,
            "travelTimeInSeconds": 134,
            "trafficDelayInSeconds": 0,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-27T22:57:43+00:00"
          }
        }
      },
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 647651,
            "travelTimeInSeconds": 26835,
            "trafficDelayInSeconds": 489,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-28T06:22:44+00:00"
          }
        }
      }
    ],
    [
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 338,
            "travelTimeInSeconds": 104,
            "trafficDelayInSeconds": 0,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-27T22:57:13+00:00"
          }
        }
      },
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 647494,
            "travelTimeInSeconds": 26763,
            "trafficDelayInSeconds": 469,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-28T06:21:32+00:00"
          }
        }
      }
    ]
  ],
  "summary": {
    "successfulRoutes": 4,
    "totalRoutes": 4
  }
}

Status code:: 202

operation-Location: New URL to check the status of the long-running operation.

Definições

Name	Description
ComputeTravelTime	Especifica se pretende devolver tempos de viagem adicionais utilizando diferentes tipos de informações de tráfego (nenhum, histórico, em direto), bem como o tempo de viagem predefinido de melhor estimativa.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
GeoJsonMultiPoint	Um tipo de geometria válido `GeoJSON MultiPoint` . Consulte RFC 7946 para obter detalhes.
InclineLevel	Grau de colina para uma rota emocionante. Este parâmetro só pode ser utilizado em conjunto com `routeType`=emocionante.
JsonFormat	Formato pretendido da resposta. Apenas `json` o formato é suportado.
RouteAvoidType	Especifica algo que o cálculo da rota deve tentar evitar ao determinar a rota. Pode ser especificado várias vezes num pedido, por exemplo, "&avoid=motorways&avoid=tollRoads&avoid=ferries". Nos pedidos do Intervalo de Rotas, o valor jáUsedRoads não pode ser utilizado.
RouteLegSummary	Objeto de resumo para a secção de rota.
RouteMatrix	Objeto de resultado de matriz
RouteMatrixQuery	Um objeto com uma matriz de coordenadas.
RouteMatrixResult	Este objeto é devolvido a partir de uma chamada de Matriz de Rota com êxito. Por exemplo, se forem fornecidas 2 origens e 3 destinos, existem 2 matrizes com 3 elementos em cada. O conteúdo de cada elemento depende das opções fornecidas na consulta.
RouteMatrixResultResponse	Objeto de resposta da célula atual na matriz de entrada.
RouteMatrixSummary	Objeto de resumo
RouteType	O tipo de rota pedida.
SectionType	Especifica qual dos tipos de secção é comunicado na resposta da rota. Por exemplo, se sectionType = peões, as secções adequadas apenas para peões são devolvidas. Podem ser utilizados vários tipos. O sectionType predefinido refere-se à entrada travelMode. Por predefinição, travelMode está definido como carro
TravelMode	O modo de viagem para a rota pedida. Se não estiver definido, a predefinição é "carro". Tenha em atenção que o travelMode pedido pode não estar disponível para toda a rota. Quando o travelMode pedido não estiver disponível para uma secção específica, o elemento travelMode da resposta para essa secção será "outro". Tenha em atenção que os modos de viagem de ônibus, motociclo, táxi e van são funcionalidades BETA. Os dados de restrição total não estão disponíveis em todas as áreas.
VehicleLoadType	Tipos de carga que podem ser classificados como materiais perigosos e restringidos a algumas estradas. Os valores de vehicleLoadType disponíveis são classes Hazmat dos EUA de 1 a 9, além de classificações genéricas para utilização noutros países/regiões. Os valores que começam com USHazmat destinam-se ao encaminhamento dos EUA, enquanto outrosHazmat devem ser utilizados para todos os outros países/regiões. vehicleLoadType pode ser especificado várias vezes. Este parâmetro é atualmente considerado apenas para travelMode=truck.
WindingnessLevel	Nível de voltas para uma rota emocionante. Este parâmetro só pode ser utilizado em conjunto com `routeType`=emocionante.

ComputeTravelTime

Especifica se pretende devolver tempos de viagem adicionais utilizando diferentes tipos de informações de tráfego (nenhum, histórico, em direto), bem como o tempo de viagem predefinido de melhor estimativa.

Name	Tipo	Description
all	string	Calcula os tempos de viagem para todos os tipos de informações de tráfego e especifica todos os resultados nos campos noTrafficTravelTimeInSeconds, historicTrafficTravelTimeInSeconds e liveTrafficIncidentsTravelTimeInSeconds incluídos nos resumos na resposta da rota.
none	string	Não calcula tempos de viagem adicionais.

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.

GeoJsonMultiPoint

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

Name	Tipo	Description
coordinates	number[]	Coordenadas para a `GeoJson MultiPoint` geometria.
type	string: MultiPoint	Especifica o `GeoJSON` tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Ponto, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

InclineLevel

Grau de colina para uma rota emocionante. Este parâmetro só pode ser utilizado em conjunto com routeType=emocionante.

Name	Tipo	Description
high	string	alta
low	string	baixo
normal	string	normal

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

RouteAvoidType

Especifica algo que o cálculo da rota deve tentar evitar ao determinar a rota. Pode ser especificado várias vezes num pedido, por exemplo, "&avoid=motorways&avoid=tollRoads&avoid=ferries". Nos pedidos do Intervalo de Rotas, o valor jáUsedRoads não pode ser utilizado.

Name	Tipo	Description
alreadyUsedRoads	string	Evita utilizar a mesma estrada várias vezes. Mais útil em conjunto com `routeType`=emocionante.
borderCrossings	string	Evita passagens fronteiriças no cálculo de rotas.
carpools	string	Evita rotas que exijam a utilização de faixas de rodagem de carpool (HOV/Veículo de Alta Ocupação).
ferries	string	Evita ferries
motorways	string	Evita auto-estradas
tollRoads	string	Evita estradas com portagens.
unpavedRoads	string	Evita estradas não repastas

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. O tempo está em UTC.
batteryConsumptionInkWh	number	Consumo estimado 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 constantSpeedConsumptionInkWhWhHundredkm 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, a recuperação sem restrições é assumida no cálculo de consumo.
departureTime	string	A hora de partida estimada para a rota ou perna. O tempo está 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	Tempo de viagem estimado calculado como se não houvesse 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.

RouteMatrix

Objeto de resultado de matriz

Name	Tipo	Description
response	RouteMatrixResultResponse	Objeto de resposta da célula atual na matriz de entrada.
statusCode	integer	Propriedade StatusCode para a célula atual na matriz de entrada.

RouteMatrixQuery

Um objeto com uma matriz de coordenadas.

Name	Tipo	Description
destinations	GeoJsonMultiPoint	Um tipo de geometria válido `GeoJSON MultiPoint` . Consulte RFC 7946 para obter detalhes.
origins	GeoJsonMultiPoint	Um tipo de geometria válido `GeoJSON MultiPoint` . Consulte RFC 7946 para obter detalhes.

RouteMatrixResult

Este objeto é devolvido a partir de uma chamada de Matriz de Rota com êxito. Por exemplo, se forem fornecidas 2 origens e 3 destinos, existem 2 matrizes com 3 elementos em cada. O conteúdo de cada elemento depende das opções fornecidas na consulta.

Name	Tipo	Description
formatVersion	string	Propriedade Formatar Versão
matrix	RouteMatrix[]	Resultados como uma matriz bidimensional de resumos de rotas.
summary	RouteMatrixSummary	Objeto de resumo

RouteMatrixResultResponse

Objeto de resposta da célula atual na matriz de entrada.

Name	Tipo	Description
routeSummary	RouteLegSummary	Objeto de resumo para a secção de rota.

RouteMatrixSummary

Objeto de resumo

Name	Tipo	Description
successfulRoutes	integer	Número de rotas bem-sucedidas na resposta.
totalRoutes	integer	Número total de rotas pedidas. Número de células na matriz de entrada.

RouteType

O tipo de rota pedida.

Name	Tipo	Description
eco	string	Uma rota equilibrada pela economia e pela velocidade.
fastest	string	A rota mais rápida.
shortest	string	A rota mais curta por distância.
thrilling	string	Inclui estradas interessantes ou desafiantes e utiliza o menor número possível de auto-estradas. Pode escolher o nível de voltas incluído e também o grau de colina. Veja os parâmetros hilliness e windingness para saber como definir isto. Existe um limite de 900 km nas rotas planeadas com `routeType`=emocionante

SectionType

Especifica qual dos tipos de secção é comunicado na resposta da rota.

Por exemplo, se sectionType = peões, as secções adequadas apenas para peões são devolvidas. Podem ser utilizados vários tipos. O sectionType predefinido refere-se à entrada travelMode. Por predefinição, travelMode está definido como carro

Name	Tipo	Description
carTrain	string	Secções da rota que são carros ou comboios.
carpool	string	Secções do percurso que exigem a utilização de pistas de carpool (HOV/Veículo de Alta Ocupação).
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.
tollRoad	string	Secções da rota que exigem o pagamento de uma portagem.
tollVignette	string	Secções da rota que requerem a presença de uma vinheta de portagem.
traffic	string	Secções da rota que contêm informações de tráfego.
travelMode	string	Secções em relação ao parâmetro `travelMode`de pedido .
tunnel	string	Secções da rota que são túneis.
urban	string	Secções da rota localizadas em áreas urbanas.

TravelMode

O modo de viagem para a rota pedida. Se não estiver definido, a predefinição é "carro". Tenha em atenção que o travelMode pedido pode não estar disponível para toda a rota. Quando o travelMode pedido não estiver disponível para uma secção específica, o elemento travelMode da resposta para essa secção será "outro". Tenha em atenção que os modos de viagem de ônibus, motociclo, táxi e van são funcionalidades BETA. Os dados de restrição total não estão disponíveis em todas as áreas.

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 de rodagem apenas. Funcionalidade BETA.
car	string	As rotas devolvidas são otimizadas para automóveis.
motorcycle	string	As rotas devolvidas são otimizadas para motociclos. Funcionalidade BETA.
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.

VehicleLoadType

Tipos de carga que podem ser classificados como materiais perigosos e restringidos a algumas estradas. Os valores de vehicleLoadType disponíveis são classes Hazmat dos EUA de 1 a 9, além de classificações genéricas para utilização noutros países/regiões. Os valores que começam com USHazmat destinam-se ao encaminhamento dos EUA, enquanto outrosHazmat devem ser utilizados para todos os outros países/regiões. vehicleLoadType pode ser especificado várias vezes. Este parâmetro é atualmente considerado apenas para travelMode=truck.

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

WindingnessLevel

Nível de voltas para uma rota emocionante. Este parâmetro só pode ser utilizado em conjunto com routeType=emocionante.

Name	Tipo	Description
high	string	alta
low	string	baixo
normal	string	normal

Route - Post Route Matrix

Submeter Pedido de Matriz de Rota síncrona

Submeter Pedido de Matriz de Rotas Assíncrona

Transferir Resultados da Sincronização

Transferir Resultados assíncronos

Parâmetros do URI

Cabeçalho do Pedido

Corpo do Pedido

Respostas

Segurança

AADToken

Notas

Scopes

subscription-key

SAS Token

Exemplos

Successfully submit a route matrix request

Sample Request

Sample Response

Definições

ComputeTravelTime

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeoJsonMultiPoint

InclineLevel

JsonFormat

RouteAvoidType

RouteLegSummary

RouteMatrix

RouteMatrixQuery

RouteMatrixResult

RouteMatrixResultResponse

RouteMatrixSummary

RouteType

SectionType

TravelMode

VehicleLoadType

WindingnessLevel

Recursos adicionais