Partilhar via

Route - Post Route Matrix

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

Use para obter uma matriz de rota mostrando o tempo de viagem e a distância para todos os pares possíveis em uma lista de origens e destinos, usando uma solicitação assíncrona.

A API Post Route Matrix é uma solicitação de POST HTTP que permite o cálculo de uma matriz de resumos de rota para um conjunto de rotas definidas por locais de origem e destino usando uma solicitação assíncrona (assíncrona). Para fazer uma solicitação síncrona (sincronização), consulte Post Route Matrix Sync. Para cada origem, o serviço calcula o custo do encaminhamento dessa origem para cada destino determinado. 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 roteamento da origem para o destino dessa célula. Como exemplo, digamos que uma empresa de entrega de comida tenha 20 motoristas e eles precisem encontrar o motorista mais próximo para pegar a entrega no restaurante. Para resolver esse caso de uso, eles podem chamar a API de Rota de Matriz.

Para cada rota, os tempos de viagem e distâncias são devolvidos. Você pode usar os custos calculados para determinar quais rotas detalhadas calcular usando a API de Direções de Rota.

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

Nota

Todas as origens e destinos devem estar contidos numa caixa delimitadora de 400 km x 400 km alinhada por eixos. Caso contrário, algumas células da matriz serão resolvidas como OUT_OF_REGION.

Enviar solicitação de matriz de rota síncrona

Se o seu cenário exigir solicitações síncronas e o tamanho máximo da matriz for menor ou igual a 100, convém fazer uma solicitação síncrona. 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, exemplos de dimensões matriciais possíveis são: 10x10, 6x8, 9x8 (não precisa ser quadrado).

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

Enviar solicitação de matriz de rota assíncrona

A API assíncrona é apropriada para processar grandes volumes de solicitações de roteamento relativamente complexas. Quando você faz uma solicitação usando uma solicitação assíncrona, por padrão, o serviço retorna um código de resposta 202 ao longo de uma URL de redirecionamento no campo Local do cabeçalho da resposta. Este URL deve ser verificado periodicamente até que os dados de resposta ou informações de erro estejam disponíveis. Se waitForResults parâmetro na solicitação estiver definido como true, o usuário obterá uma resposta 200 se a solicitação for concluída 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, exemplos de dimensões matriciais possíveis são: 50x10, 10x10, 28x25. 10x70 (não precisa ser quadrado).

As respostas assíncronas são armazenadas por 24 horas. O URL de redirecionamento retorna uma resposta 404 se usado após o período de expiração.

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

Aqui está uma sequência típica de operações assíncronas:

  1. O cliente envia uma solicitação POST da Matriz de Rota para o Azure Maps

  2. O servidor responderá com uma das seguintes opções:

    HTTP 202 Accepted - A solicitação de matriz de rota foi aceita.

    HTTP Error - Ocorreu um erro ao processar o seu pedido de Route Matrix. Isso pode ser uma solicitação incorreta 400 ou qualquer outro código de status de erro.

  3. Se a solicitação de Rota de Matriz foi aceita com êxito, o cabeçalho Location na resposta contém a URL para baixar os resultados da solicitação. Esse URI de status tem a seguinte aparência:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. O cliente emite uma solicitação GET no URL de download obtido na Etapa 3 para baixar os resultados

Baixar resultados de sincronização

Quando você faz uma solicitação POST para a API de sincronização da matriz de rota, o serviço retorna 200 código de resposta para solicitação bem-sucedida e uma matriz de resposta. O corpo da resposta conterá os dados e não haverá possibilidade de recuperar os resultados mais tarde.

Baixar resultados assíncronos

Quando uma solicitação emite uma resposta 202 Accepted, a solicitação está sendo processada usando nosso pipeline assíncrono. Você receberá uma URL para verificar o progresso da sua solicitação assíncrona no cabeçalho do local da resposta. Esse URI de status tem a seguinte aparência:

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

O URL fornecido pelo cabeçalho do local retornará as seguintes respostas quando uma solicitação de GET for emitida.

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

HTTP 200 OK - Pedido de matriz processado com sucesso. O corpo da resposta contém todos os resultados.

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0
Com parâmetros opcionais: 
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 desejado da resposta. Apenas json formato é suportado.
api-version
 query True

string

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

string

date-time

A data e a hora de chegada ao ponto de destino formatadas como um valor de dateTime, conforme definido no RFC 3339, seção 5.6, com um deslocamento de fuso horário opcional. Quando um deslocamento de fuso horário não é especificado, presumir-se-á que é o do ponto de destino.

Exemplos:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

O parâmetro arriveAt não pode ser usado em conjunto com departAt, minDeviationDistance ou minDeviationTime.
avoid
 query

RouteAvoidType[]

Especifica algo que o cálculo de rota deve tentar evitar ao determinar a rota. Pode ser especificado várias vezes em um pedido, por exemplo, '&evita=autoestradas&evita=pedágioEstradas&evitar=ferries'. Em solicitações de intervalo de rotas, o valor alreadyUsedRoads não deve ser usado.
computeTravelTimeFor
 query

ComputeTravelTime

Especifica se os tempos de viagem adicionais devem ser devolvidos usando diferentes tipos de informações de tráfego (nenhum, histórico, ao vivo), bem como o tempo de viagem padrão com melhor estimativa.
departAt
 query

string

date-time

A data e hora de partida do ponto de origem formatado como um valor de dateTime, conforme definido no RFC 3339, seção 5.6, com um deslocamento de fuso horário opcional. Quando um deslocamento de fuso horário não é especificado, presumir-se-á que é o do ponto de origem.

  • Valor padrão: agora
  • Outro valor: dateTime

Exemplos:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

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

InclineLevel

Grau de acidez para uma rota emocionante. Este parâmetro só pode ser usado em conjunto com routeType=thrilling.
routeType
 query

RouteType

O tipo de rota solicitada.
sectionType
 query

SectionType[]

Especifica qual dos tipos de seção é relatado na resposta da rota.

Por exemplo, se sectionType = pedestre, as seções que são adequadas apenas para pedestres são retornadas. Pode ser especificado várias vezes em um pedido, por exemplo, '§ionType=carTrain§ionType=pedestrian§ionType=motorway'. O padrão sectionType refere-se à entrada travelMode. Por padrã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 roteamento
  • false - Ignore os dados de tráfego atuais durante o roteamento. Note-se que, embora os dados de tráfego atuais sejam ignorados durante o encaminhamento, o efeito do tráfego histórico nas velocidades efetivas da estrada ainda é incorporado.
travelMode
 query

TravelMode

O modo de viagem para a rota solicitada. Se não estiver definido, o padrão é 'carro'. Observe que o travelMode solicitado pode não estar disponível para toda a rota. Quando o travelMode solicitado não estiver disponível para uma seção específica, o elemento travelMode da resposta para essa seção será "outro". Observe que os modos de viagem ônibus, motocicleta, táxi e van são funcionalidades BETA. Os dados completos de restrição não estão disponíveis em todas as áreas.
vehicleAxleWeight
 query

integer

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

number

double

Altura do veículo em metros. Um valor 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 partir de algumas estradas. Os valores de vehicleLoadType disponíveis são classes 1 a 9 do US Hazmat, além de classificações genéricas para uso em outros países/regiões. Os valores que começam com USHazmat são para roteamento dos EUA, enquanto otherHazmat deve ser usado para todos os outros países/regiões. vehicleLoadType pode ser especificado várias vezes. Atualmente, este parâmetro só é considerado 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 em autoestradas.

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

  • Um valor diferente de zero pode ser substituído durante o planejamento de rotas. Por exemplo, o fluxo de tráfego atual é de 60 km/hora. Se a velocidade máxima do veículo estiver definida para 50 km/hora, o motor de encaminhamento considerará 60 km/hora, uma vez que esta é a situação atual. Se a velocidade máxima do veículo for fornecida como 80 km/hora, mas o fluxo de tráfego atual for de 60 km/hora, o motor de roteamento usará novamente 60 km/hora.
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 a solicitação deve ser executada de forma síncrona. Se definido como true, o usuário receberá uma resposta 200 se a solicitação for concluída em menos de 120 segundos. Caso contrário, o usuário receberá uma resposta 202 imediatamente. Consulte a descrição da API para obter mais detalhes sobre a resposta 202. Suportado apenas para solicitação assíncrona.
windingness
 query

WindingnessLevel

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

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.

Corpo do Pedido

Name Tipo Description
destinations

GeoJsonMultiPoint

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

GeoJsonMultiPoint

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

Respostas

Name Tipo Description
200 OK

RouteMatrixResult

Pedido matricial processado com sucesso. O corpo da resposta contém todos os resultados.
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.

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 submit a route matrix request

Pedido de amostra

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

Resposta da amostra

Código de estado:
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
  }
}
Código de estado:
202 
operation-Location: New URL to check the status of the long-running operation.

Definições

Name Description
ComputeTravelTime

Especifica se os tempos de viagem adicionais devem ser devolvidos usando diferentes tipos de informações de tráfego (nenhum, histórico, ao vivo), bem como o tempo de viagem padrão com melhor estimativa.
ErrorAdditionalInfo

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

O detalhe do erro.
ErrorResponse

Resposta de erro
GeoJsonMultiPoint

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

Grau de acidez para uma rota emocionante. Este parâmetro só pode ser usado em conjunto com routeType=thrilling.
JsonFormat

Formato desejado da resposta. Apenas json formato é suportado.
RouteAvoidType

Especifica algo que o cálculo de rota deve tentar evitar ao determinar a rota. Pode ser especificado várias vezes em um pedido, por exemplo, '&evita=autoestradas&evita=pedágioEstradas&evitar=ferries'. Em solicitações de intervalo de rotas, o valor alreadyUsedRoads não deve ser usado.
RouteLegSummary

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

Objeto de resultado da matriz
RouteMatrixQuery

Um objeto com uma matriz de coordenadas.
RouteMatrixResult

Este objeto é retornado de uma chamada Route Matrix bem-sucedida. Por exemplo, se forem fornecidas 2 origens e 3 destinos, haverá 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 solicitada.
SectionType

Especifica qual dos tipos de seção é relatado na resposta da rota.

Por exemplo, se sectionType = pedestre, as seções que são adequadas apenas para pedestres são retornadas. Pode ser especificado várias vezes em um pedido, por exemplo, '§ionType=carTrain§ionType=pedestrian§ionType=motorway'. O padrão sectionType refere-se à entrada travelMode. Por padrão, travelMode está definido como carro
TravelMode

O modo de viagem para a rota solicitada. Se não estiver definido, o padrão é 'carro'. Observe que o travelMode solicitado pode não estar disponível para toda a rota. Quando o travelMode solicitado não estiver disponível para uma seção específica, o elemento travelMode da resposta para essa seção será "outro". Observe que os modos de viagem ônibus, motocicleta, táxi e van são funcionalidades BETA. Os dados completos de restrição não estão disponíveis em todas as áreas.
VehicleLoadType

Tipos de carga que podem ser classificados como materiais perigosos e restringidos a partir de algumas estradas. Os valores de vehicleLoadType disponíveis são classes 1 a 9 do US Hazmat, além de classificações genéricas para uso em outros países/regiões. Os valores que começam com USHazmat são para roteamento dos EUA, enquanto otherHazmat deve ser usado para todos os outros países/regiões. vehicleLoadType pode ser especificado várias vezes. Atualmente, este parâmetro só é considerado para travelMode=truck.
WindingnessLevel

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

ComputeTravelTime

Especifica se os tempos de viagem adicionais devem ser devolvidos usando diferentes tipos de informações de tráfego (nenhum, histórico, ao vivo), bem como o tempo de viagem padrão com 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

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

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

Resposta de erro

Name Tipo Description
error

ErrorDetail

O objeto de erro.

GeoJsonMultiPoint

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

Name Tipo Description
coordinates

number[]

Coordenadas para a geometria GeoJson MultiPoint.
type string:

MultiPoint

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

InclineLevel

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

Name Tipo Description
high

string

alto
low

string

baixo
normal

string

normal

JsonFormat

Formato desejado da resposta. Apenas json formato é suportado.

Name Tipo Description
json

string

O formato de intercâmbio de dados de notação de objeto JavaScript

RouteAvoidType

Especifica algo que o cálculo de rota deve tentar evitar ao determinar a rota. Pode ser especificado várias vezes em um pedido, por exemplo, '&evita=autoestradas&evita=pedágioEstradas&evitar=ferries'. Em solicitações de intervalo de rotas, o valor alreadyUsedRoads não deve ser usado.

Name Tipo Description
alreadyUsedRoads

string

Evita usar a mesma estrada várias vezes. Mais útil em conjunto com routeType=emocionante.
borderCrossings

string

Evita passagens de fronteira no cálculo de rotas.
carpools

string

Evita percursos que exijam a utilização de faixas de carpool (HOV/High Occupancy Vehicle).
ferries

string

Evita ferries
motorways

string

Evita autoestradas
tollRoads

string

Evita estradas com portagem.
unpavedRoads

string

Evita estradas não pavimentadas

RouteLegSummary

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

Name Tipo Description
arrivalTime

string

A hora prevista de chegada para o percurso ou trecho. A hora está em UTC.
batteryConsumptionInkWh

number

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

A hora de partida estimada para a rota ou trecho. A hora está em UTC.
fuelConsumptionInLiters

number

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.

RouteMatrix

Objeto de resultado da 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 GeoJSON MultiPoint válido. Consulte RFC 7946 para obter detalhes.
origins

GeoJsonMultiPoint

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

RouteMatrixResult

Este objeto é retornado de uma chamada Route Matrix bem-sucedida. Por exemplo, se forem fornecidas 2 origens e 3 destinos, haverá 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 Format Version
matrix

RouteMatrix[]

Resultados como uma matriz de 2 dimensões 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 seçã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 solicitadas. Número de células na matriz de entrada.

RouteType

O tipo de rota solicitada.

Name Tipo Description
eco

string

Uma rota equilibrada pela economia e velocidade.
fastest

string

A rota mais rápida.
shortest

string

O percurso mais curto por distância.
thrilling

string

Inclui estradas interessantes ou desafiantes e utiliza o menor número possível de autoestradas. Você pode escolher o nível de voltas incluídas e também o grau de inclinação. Veja os parâmetros de inclinação e enrolamento para saber como definir isso. Há um limite de 900 km em rotas planejadas com routeType=emocionante

SectionType

Especifica qual dos tipos de seção é relatado na resposta da rota.

Por exemplo, se sectionType = pedestre, as seções que são adequadas apenas para pedestres são retornadas. Pode ser especificado várias vezes em um pedido, por exemplo, '§ionType=carTrain§ionType=pedestrian§ionType=motorway'. O padrão sectionType refere-se à entrada travelMode. Por padrão, travelMode está definido como carro

Name Tipo Description
carTrain

string

Troços do percurso que são carros ou comboios.
carpool

string

Troços do percurso que requerem a utilização de faixas de carpool (HOV/High Occupancy Vehicle).
country

string

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

string

Troços do percurso que são ferries.
motorway

string

Troços do percurso que são autoestradas.
pedestrian

string

Troços do percurso que só servem para peões.
tollRoad

string

Troços do percurso que exigem o pagamento de portagens.
tollVignette

string

Troços do percurso que requerem vinheta de portagem para estarem presentes.
traffic

string

Seções da rota que contêm informações de tráfego.
travelMode

string

Seções em relação ao parâmetro request travelMode.
tunnel

string

Troços do percurso que são túneis.
urban

string

Troços do percurso situados em zonas urbanas.

TravelMode

O modo de viagem para a rota solicitada. Se não estiver definido, o padrão é 'carro'. Observe que o travelMode solicitado pode não estar disponível para toda a rota. Quando o travelMode solicitado não estiver disponível para uma seção específica, o elemento travelMode da resposta para essa seção será "outro". Observe que os modos de viagem ônibus, motocicleta, táxi e van são funcionalidades BETA. Os dados completos de restrição não estão disponíveis em todas as áreas.

Name Tipo Description
bicycle

string

As rotas devolvidas são otimizadas para bicicletas, incluindo o uso de ciclovias.
bus

string

As rotas de retorno são otimizadas para ônibus, incluindo o uso de faixas exclusivas para ônibus. Funcionalidade BETA.
car

string

As rotas devolvidas são otimizadas para carros.
motorcycle

string

As rotas devolvidas são otimizadas para motocicletas. Funcionalidade BETA.
pedestrian

string

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

string

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

string

As rotas de retorno são otimizadas para veículos comerciais, como para caminhões.
van

string

As rotas devolvidas são otimizadas para vans. Funcionalidade BETA.

VehicleLoadType

Tipos de carga que podem ser classificados como materiais perigosos e restringidos a partir de algumas estradas. Os valores de vehicleLoadType disponíveis são classes 1 a 9 do US Hazmat, além de classificações genéricas para uso em outros países/regiões. Os valores que começam com USHazmat são para roteamento dos EUA, enquanto otherHazmat deve ser usado para todos os outros países/regiões. vehicleLoadType pode ser especificado várias vezes. Atualmente, este parâmetro só é considerado 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

Oxidantes
USHazmatClass6

string

Venenos
USHazmatClass7

string

Radioativo
USHazmatClass8

string

Corrosivos
USHazmatClass9

string

Disposições diversas
otherHazmatExplosive

string

Explosivos
otherHazmatGeneral

string

Disposições diversas
otherHazmatHarmfulToWater

string

Nocivo para a água

WindingnessLevel

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

Name Tipo Description
high

string

alto
low

string

baixo
normal

string

normal