Route - Post Route Matrix Sync

Referência

Serviço:: Maps

Versão da API:: 1.0

Use para obter uma matriz de rotas 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 síncrona.

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

Para cada rota, os tempos de viagem e as distâncias são retornados. Você pode usar os custos computados 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 a solicitação de sincronização, é 100 (o número de origens multiplicado pelo número de destinos).

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

Se o 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 essa API é 100 (o número de origens multiplicado pelo número de destinos). Com essa restrição em mente, exemplos de dimensões de matriz 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 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 de resposta. Essa URL deve ser verificada periodicamente até que os dados de resposta ou informações de erro estejam disponíveis. Se waitForResults parâmetro na solicitação for definido como true, o usuário receberá uma resposta 200 se a solicitação for concluída em menos de 120 segundos.

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

As respostas assíncronas são armazenadas por 24 horas. A URL de redirecionamento retorna uma resposta 404 se usada 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:

O cliente envia uma solicitação POST de Matriz de Rotas para o Azure Mapas
O servidor responderá com um dos seguintes:

HTTP 202 Accepted – A solicitação de Matriz de Rota foi aceita.

HTTP Error - Houve um erro ao processar sua solicitação de Matriz de Rotas. Pode ser uma solicitação 400 incorreta ou qualquer outro código de status de erro.
Se a solicitação de Rota da Matriz foi aceita com êxito, o cabeçalho Local na resposta contém a URL para baixar os resultados da solicitação. Esse URI de status é semelhante ao seguinte:

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

O cliente emite uma solicitação GET na URL de download obtida na Etapa 3 para baixar os resultados

Baixar resultados da sincronização

Quando você faz uma solicitação POST para a API de Sincronização de Matriz de Rota, o serviço retorna 200 códigos de resposta para solicitação bem-sucedida e uma matriz de resposta. O corpo da resposta conterá os dados e não haverá nenhuma possibilidade de recuperar os resultados posteriormente.

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 solicitação assíncrona no cabeçalho de localização da resposta. Esse URI de status é semelhante ao seguinte:

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

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

HTTP 202 Accepted - A solicitação matrix foi aceita, mas ainda está sendo processada. Tente novamente em algum tempo.

HTTP 200 OK – Solicitação de matriz processada com êxito. O corpo da resposta contém todos os resultados.

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

Com parâmetros opcionais:

POST https://atlas.microsoft.com/route/matrix/sync/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 de URI

Nome	Em	Obrigatório	Tipo	Description
format	path	True	JsonFormat	Formato desejado da resposta. Há suporte apenas para `json` formato.
api-version	query	True	string	Número de versão da API do Azure Mapas.
arriveAt	query		string date-time	A data e hora de chegada no ponto de destino formatado como um valor `dateTime`, conforme definido em RFC 3339, seção 5.6, com um deslocamento de fuso horário opcional. Quando um deslocamento de fuso horário não for especificado, ele será considerado 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 uma solicitação, por exemplo, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. Em solicitações de Intervalo de Rotas, o valor alreadyUsedRoads não deve ser usado.
computeTravelTimeFor	query		ComputeTravelTime	Especifica se é necessário retornar tempos de viagem adicionais usando diferentes tipos de informações de tráfego (nenhum, histórico, ao vivo), bem como o tempo de viagem de melhor estimativa padrão.
departAt	query		string date-time	A data e hora da partida do ponto de origem formatado como um valor `dateTime` conforme definido em RFC 3339, seção 5.6, com um deslocamento de fuso horário opcional. Quando um deslocamento de fuso horário não for especificado, ele será considerado 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 colina para uma rota emocionante. Esse parâmetro só pode ser usado em conjunto com `routeType`=emocionante.
routeType	query		RouteType	O tipo de rota solicitada.
sectionType	query		SectionType[]	Especifica quais dos tipos de seção são relatados 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 uma solicitação, por exemplo, '§ionType=carTrain§ionType=pedestrian§ionType=motorway'. O sectionType padrão refere-se à entrada travelMode. Por padrão, travelMode é definido como carro
traffic	query		boolean	Valores possíveis: true – Considere todas as informações de tráfego disponíveis durante o roteamento false – ignorar os dados de tráfego atuais durante o roteamento. Observe que, embora os dados de tráfego atuais sejam ignorados durante o roteamento, o efeito do tráfego histórico em velocidades de estrada efetivas ainda é incorporado.
travelMode	query		TravelMode	O modo de viagem para a rota solicitada. Se não for definido, o padrão será "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 dessa seção será "outro". Observe que os modos de viagem de ônibus, moto, táxi e van são funcionalidade BETA. Os dados de restrição completa 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 classificadas como materiais perigosos e restritas de algumas estradas. Os valores de vehicleLoadType disponíveis são as classes Hazmat dos EUA de 1 a 9, além de classificações genéricas para uso em outros países/regiões. Os valores que começam com USHazmat são para roteamento dos EUA, enquanto outrosHazmat devem ser usados para todos os outros países/regiões. vehicleLoadType pode ser especificado várias vezes. Atualmente, esse parâmetro é 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 é usada para verificar se um veículo é permitido em auto-estradas. Um valor de 0 significa que um valor apropriado para o veículo será determinado e aplicado durante o planejamento da rota. Um valor diferente de zero pode ser substituído durante o planejamento de rota. Por exemplo, o fluxo de tráfego atual é de 60 km/hora. Se a velocidade máxima do veículo for definida como 50 km/hora, o motor de roteamento considerará 60 km/hora, pois essa é a situação atual. Se a velocidade máxima do veículo for fornecida como 80 km/hora, mas o fluxo de tráfego atual for de 60 km/hora, o mecanismo de roteamento usará novamente 60 km/hora.
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	Booliano 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. com suporte apenas parade solicitação assíncrona.
windingness	query		WindingnessLevel	Nível de voltas para uma rota emocionante. Esse parâmetro só pode ser usado em conjunto com `routeType`=emocionante.

Cabeçalho da solicitação

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

Corpo da solicitação

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

Respostas

Nome	Tipo	Description
200 OK	RouteMatrixResult	Solicitação de matriz processada com êxito. O corpo da resposta contém todos os resultados.
Other Status Codes	ErrorResponse	Tempo limite: a solicitação demorou mais tempo para ser concluída do que o tempo máximo definido na api.
Other Status Codes	ErrorResponse	Ocorreu um erro inesperado.

Segurança

AADToken

Estas são as Fluxos de do Microsoft Entra OAuth 2.0. Quando emparelhado com acesso baseado em função do Azure controle, ele pode ser usado para controlar o acesso às APIs REST do Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais sub-recursos ou conta de recurso do Azure Mapas. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para APIs REST do Azure Mapas.

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

Anotações

Essa definição de segurança requer o uso do cabeçalho x-ms-client-id para indicar a qual recurso do Azure Mapas o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento do Mapas.

O Authorization URL é específico para a instância de nuvem pública do Azure. Nuvens soberanas têm URLs de autorização exclusivas e configurações de ID do Microsoft Entra. * O controle de acesso baseado em função do Azure é configurado do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST. * O uso do SDK da Web do Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.

Para obter mais informações sobre a plataforma de identidade da Microsoft, consulte visão geral da plataforma de identidade da Microsoft.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

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

subscription-key

Essa é uma chave compartilhada provisionada quando você Criar uma conta do Azure Mapas no portal do Azure ou usando o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com essa chave, qualquer aplicativo pode acessar toda a API REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta em que elas são emitidas.

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

Tipo: apiKey
Em: query

SAS Token

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

Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado para expiração, taxa e região(s) de uso para o token específico. Em outras palavras, o Token SAS pode ser usado para permitir que os aplicativos controlem o acesso de forma mais protegida do que a chave compartilhada.

Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no de recursos da conta de mapa de para limitar o abuso de renderização e renovar regularmente o Token SAS.

Tipo: apiKey
Em: header

Exemplos

Successfully retrieve a route matrix request result synchronously

Solicitação de exemplo

HTTP

POST https://atlas.microsoft.com/route/matrix/sync/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 de exemplo

Código de status:: 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 status:: 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

Nome	Description
ComputeTravelTime	Especifica se é necessário retornar tempos de viagem adicionais usando diferentes tipos de informações de tráfego (nenhum, histórico, ao vivo), bem como o tempo de viagem de melhor estimativa padrão.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
GeoJsonMultiPoint	Um tipo de geometria de `GeoJSON MultiPoint` válido. Consulte RFC 7946 para obter detalhes.
InclineLevel	Grau de colina para uma rota emocionante. Esse parâmetro só pode ser usado em conjunto com `routeType`=emocionante.
JsonFormat	Formato desejado da resposta. Há suporte apenas para `json` formato.
RouteAvoidType	Especifica algo que o cálculo de rota deve tentar evitar ao determinar a rota. Pode ser especificado várias vezes em uma solicitação, por exemplo, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. Em solicitações de Intervalo de Rotas, o valor alreadyUsedRoads não deve ser usado.
RouteLegSummary	Objeto resumo da seção de rota.
RouteMatrix	Objeto de resultado da matriz
RouteMatrixQuery	Um objeto com uma matriz de coordenadas.
RouteMatrixResult	Esse objeto é retornado de uma chamada bem-sucedida da Matriz de Rotas. Por exemplo, se 2 origens e 3 destinos forem fornecidos, 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 resumo
RouteType	O tipo de rota solicitada.
SectionType	Especifica quais dos tipos de seção são relatados 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 uma solicitação, por exemplo, '§ionType=carTrain§ionType=pedestrian§ionType=motorway'. O sectionType padrão refere-se à entrada travelMode. Por padrão, travelMode é definido como carro
TravelMode	O modo de viagem para a rota solicitada. Se não for definido, o padrão será "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 dessa seção será "outro". Observe que os modos de viagem de ônibus, moto, táxi e van são funcionalidade BETA. Os dados de restrição completa não estão disponíveis em todas as áreas.
VehicleLoadType	Tipos de carga que podem ser classificadas como materiais perigosos e restritas de algumas estradas. Os valores de vehicleLoadType disponíveis são as classes Hazmat dos EUA de 1 a 9, além de classificações genéricas para uso em outros países/regiões. Os valores que começam com USHazmat são para roteamento dos EUA, enquanto outrosHazmat devem ser usados para todos os outros países/regiões. vehicleLoadType pode ser especificado várias vezes. Atualmente, esse parâmetro é considerado apenas para travelMode=truck.
WindingnessLevel	Nível de voltas para uma rota emocionante. Esse parâmetro só pode ser usado em conjunto com `routeType`=emocionante.

ComputeTravelTime

Especifica se é necessário retornar tempos de viagem adicionais usando diferentes tipos de informações de tráfego (nenhum, histórico, ao vivo), bem como o tempo de viagem de melhor estimativa padrão.

Nome	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 noTraffic TravelTimeInSeconds, historicTraffic TravelTimeInSeconds e liveTrafficIncidents TravelTimeInSeconds incluídos nos resumos na resposta da rota.
none	string	Não computa tempos de viagem adicionais.

ErrorAdditionalInfo

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

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

ErrorDetail

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

GeoJsonMultiPoint

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

Nome	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 colina para uma rota emocionante. Esse parâmetro só pode ser usado em conjunto com routeType=emocionante.

Nome	Tipo	Description
high	string	alto
low	string	baixo
normal	string	normal

JsonFormat

Formato desejado da resposta. Há suporte apenas para json formato.

Nome	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 uma solicitação, por exemplo, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. Em solicitações de Intervalo de Rotas, o valor alreadyUsedRoads não deve ser usado.

Nome	Tipo	Description
alreadyUsedRoads	string	Evita usar a mesma estrada várias vezes. Mais útil em conjunto com `routeType`=emocionante.
borderCrossings	string	Evita cruzamentos de borda no cálculo de rota.
carpools	string	Evita rotas que exigem o uso de faixas de carona (HOV/Veículo de Alta Ocupação).
ferries	string	Evita balsas
motorways	string	Evita auto-estradas
tollRoads	string	Evita estradas pedagiadas.
unpavedRoads	string	Evita estradas não pavimentadas

RouteLegSummary

Objeto resumo da seção de rota.

Nome	Tipo	Description
arrivalTime	string	A hora de chegada estimada para a rota ou a perna. A hora está em UTC.
batteryConsumptionInkWh	number	Consumo estimado de energia elétrica em quilowatts-hora (kWh) usando 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 o 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 não treinada será assumida no cálculo de consumo.
departureTime	string	A hora de partida estimada para a rota ou a perna. A hora está em UTC.
fuelConsumptionInLiters	number	Consumo estimado de combustível em litros usando o Modelo de Consumo de Combustão. Incluído se vehicleEngineType estiver definido como de combustão e constantSpeedConsumptionInLitersPerHundredkm for especificado. O valor não será negativo.
historicTrafficTravelTimeInSeconds	integer	Tempo de viagem estimado calculado usando dados de tráfego histórico dependentes do tempo. Incluído somente se computeTravelTimeFor = tudo for usado na consulta.
lengthInMeters	integer	Propriedade Length In Meters
liveTrafficIncidentsTravelTimeInSeconds	integer	Tempo de viagem estimado calculado usando dados de velocidade em tempo real. Incluído somente se computeTravelTimeFor = tudo for usado 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 somente se computeTravelTimeFor = tudo for usado na consulta.
trafficDelayInSeconds	integer	Atraso estimado em segundos causado pelos incidentes em tempo real, de acordo com informações de tráfego. Para rotas planejadas com hora 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 compute TravelTimeFor=tudo precisa ser adicionado.
travelTimeInSeconds	integer	Propriedade estimada do tempo de viagem 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 estiver no futuro, o tempo de viagem será calculado usando dados de tráfego histórico dependentes do tempo.

RouteMatrix

Objeto de resultado da matriz

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

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

RouteMatrixResult

Esse objeto é retornado de uma chamada bem-sucedida da Matriz de Rotas. Por exemplo, se 2 origens e 3 destinos forem fornecidos, haverá 2 matrizes com 3 elementos em cada. O conteúdo de cada elemento depende das opções fornecidas na consulta.

Nome	Tipo	Description
formatVersion	string	Propriedade Format Version
matrix	RouteMatrix[]	Resulta como uma matriz bidimensional de resumos de rotas.
summary	RouteMatrixSummary	Objeto resumo

RouteMatrixResultResponse

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

Nome	Tipo	Description
routeSummary	RouteLegSummary	Objeto resumo da seção de rota.

RouteMatrixSummary

Objeto resumo

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

Nome	Tipo	Description
eco	string	Uma rota equilibrada por economia e velocidade.
fastest	string	A rota mais rápida.
shortest	string	A rota mais curta por distância.
thrilling	string	Inclui estradas interessantes ou desafiadoras e usa o menor número possível de auto-estradas. Você pode escolher o nível de turnos incluído e também o grau de hilliness. Consulte os parâmetros de hilliness e windingness para saber como definir isso. Há um limite de 900 km em rotas planejadas com `routeType`=emocionante

SectionType

Especifica quais dos tipos de seção são relatados 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 uma solicitação, por exemplo, '§ionType=carTrain§ionType=pedestrian§ionType=motorway'. O sectionType padrão refere-se à entrada travelMode. Por padrão, travelMode é definido como carro

Nome	Tipo	Description
carTrain	string	Seções da rota que são carros ou trens.
carpool	string	Seções da rota que exigem o uso de faixas de carona (HOV/Veículo de Alta Ocupação).
country	string	Seções que indicam em quais países/regiões a rota está.
ferry	string	Seções da rota que são balsas.
motorway	string	Seções da rota que são auto-estradas.
pedestrian	string	Seções da rota que são adequadas apenas para pedestres.
tollRoad	string	Seções da rota que exigem um pedágio a ser pago.
tollVignette	string	Seções da rota que exigem uma vinheta de pedágio para estar presente.
traffic	string	Seções da rota que contêm informações de tráfego.
travelMode	string	Seções em relação ao parâmetro de solicitação `travelMode`.
tunnel	string	Seções da rota que são túneis.
urban	string	Seções da rota que estão localizadas em áreas urbanas.

TravelMode

O modo de viagem para a rota solicitada. Se não for definido, o padrão será "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 dessa seção será "outro". Observe que os modos de viagem de ônibus, moto, táxi e van são funcionalidade BETA. Os dados de restrição completa não estão disponíveis em todas as áreas.

Nome	Tipo	Description
bicycle	string	As rotas retornadas são otimizadas para bicicletas, incluindo o uso de ciclovias.
bus	string	As rotas retornadas são otimizadas para ônibus, incluindo o uso de faixas somente de ônibus. Funcionalidade BETA.
car	string	As rotas retornadas são otimizadas para carros.
motorcycle	string	As rotas retornadas são otimizadas para motocicletas. Funcionalidade BETA.
pedestrian	string	As rotas retornadas são otimizadas para pedestres, incluindo o uso de calçadas.
taxi	string	As rotas retornadas são otimizadas para táxis. Funcionalidade BETA.
truck	string	As rotas retornadas são otimizadas para veículos comerciais, como para caminhões.
van	string	As rotas retornadas são otimizadas para vans. Funcionalidade BETA.

VehicleLoadType

Tipos de carga que podem ser classificadas como materiais perigosos e restritas de algumas estradas. Os valores de vehicleLoadType disponíveis são as classes Hazmat dos EUA de 1 a 9, além de classificações genéricas para uso em outros países/regiões. Os valores que começam com USHazmat são para roteamento dos EUA, enquanto outrosHazmat devem ser usados para todos os outros países/regiões. vehicleLoadType pode ser especificado várias vezes. Atualmente, esse parâmetro é considerado apenas para travelMode=truck.

Nome	Tipo	Description
USHazmatClass1	string	Explosivos
USHazmatClass2	string	Gás compactado
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	Variado
otherHazmatExplosive	string	Explosivos
otherHazmatGeneral	string	Variado
otherHazmatHarmfulToWater	string	Prejudicial à água

WindingnessLevel

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

Nome	Tipo	Description
high	string	alto
low	string	baixo
normal	string	normal

Compartilhar via