Partilhar via

RouteGetRouteDirectionsQueryParamProperties interface

  • Referência
Pacote:
@azure-rest/maps-route

Propriedades

accelerationEfficiency

Especifica a eficiência da conversão da energia química armazenada no combustível em energia cinética quando o veículo acelera (ou seja, KineticEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed é obtido convertendo combustível consumido em energia química usando fuelEnergyDensityInMJoulesPerLiter.

Deve ser emparelhado com desaceleraçãoEficiência.

O intervalo de valores permitidos são de 0,0 a 1/desaceleraçãoEficiência.

Valores sensíveis: para modelo de combustão: 0,33, para modelo elétrico: 0,66
alternativeType

Controla a otimização, em relação aos critérios de planeamento fornecidos, das alternativas calculadas em comparação com a rota de referência.
arriveAt

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

Especifica a quantidade de energia consumida para sustentar sistemas auxiliares, em quilowatts (kW).

Ele pode ser usado para especificar o consumo devido a dispositivos e sistemas, como sistemas de CA, rádio, aquecimento, etc.

Valores sensíveis : 1.7
auxiliaryPowerInLitersPerHour

Especifica a quantidade de combustível consumida para sustentar os sistemas auxiliares do veículo, em litros por hora.

Ele pode ser usado para especificar o consumo devido a dispositivos e sistemas, como sistemas de CA, rádio, aquecimento, etc.

Valores sensíveis : 0.2
avoid

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

Reordene os waypoints de rota usando um algoritmo heurístico rápido para reduzir o comprimento da rota. Produz melhores resultados quando usado em conjunto com routeType mais curto. Observe que origem e destino são excluídos dos índices de waypoint otimizados. Para incluir origem e destino na resposta, aumente todos os índices em 1 para levar em conta a origem e, em seguida, adicione o destino como o índice final. Os valores possíveis são true ou false. True calcula uma ordem melhor, se possível, mas não pode ser usado em conjunto com o valor maxAlternatives maior que 0 ou em conjunto com waypoints circulares. False usará os locais na ordem dada e não poderá ser usado em conjunto com routeRepresentation nenhum.
computeTravelTimeFor

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

Especifica o componente dependente da velocidade do consumo.

Fornecido como uma lista não ordenada de pares de velocidade/taxa de consumo. A lista define pontos em uma curva de consumo. As taxas de consumo para velocidades que não constam da lista são as seguintes:

  • por interpolação linear, se a velocidade indicada estiver compreendida entre duas velocidades na lista

  • por extrapolação linear caso contrário, pressupondo uma constante (ΔConsumption/ΔSpeed) determinada pelos dois pontos mais próximos da lista

A lista deve conter entre 1 e 25 pontos (inclusive) e não pode conter pontos duplicados para a mesma velocidade. Se contiver apenas um único ponto, a taxa de consumo desse ponto é utilizada sem processamento adicional.

O consumo especificado para a velocidade maior deve ser igual ou superior ao da penúltima velocidade maior. Desta forma, garante-se que a extrapolação não conduza a taxas de consumo negativas.

Do mesmo modo, os valores de consumo especificados para as duas velocidades mais pequenas da lista não podem conduzir a uma taxa de consumo negativa para qualquer velocidade inferior.

O intervalo válido para os valores de consumo (expresso em kWh/100km) situa-se entre 0,01 e 100000,0.

Valores sensíveis : 50,8.2:130,21.3

Este parâmetro é necessário para modelo de consumo elétrico.
constantSpeedConsumptionInLitersPerHundredkm

Especifica o componente dependente da velocidade do consumo.

Fornecido como uma lista não ordenada de pares de velocidade & taxa de consumo delimitados por dois pontos. A lista define pontos em uma curva de consumo. As taxas de consumo para velocidades que não constam da lista são as seguintes:

  • por interpolação linear, se a velocidade indicada estiver compreendida entre duas velocidades na lista

  • por extrapolação linear caso contrário, pressupondo uma constante (ΔConsumption/ΔSpeed) determinada pelos dois pontos mais próximos da lista

A lista deve conter entre 1 e 25 pontos (inclusive) e não pode conter pontos duplicados para a mesma velocidade. Se contiver apenas um único ponto, a taxa de consumo desse ponto é utilizada sem processamento adicional.

O consumo especificado para a velocidade maior deve ser igual ou superior ao da penúltima velocidade maior. Desta forma, garante-se que a extrapolação não conduza a taxas de consumo negativas.

Do mesmo modo, os valores de consumo especificados para as duas velocidades mais pequenas da lista não podem conduzir a uma taxa de consumo negativa para qualquer velocidade inferior.

O intervalo válido para os valores de consumo (expresso em l/100km) situa-se entre 0,01 e 100000,0.

Valores sensíveis : 50,6.3:130,11.5

Nota : Este parâmetro é necessário para O Modelo de Consumo de Combustão.
currentChargeInkWh

Especifica o fornecimento atual de energia elétrica em quilowatts-hora (kWh).

Este parâmetro coexiste com parâmetro maxChargeInkWh.

O intervalo de valores permitidos é de 0,0 a maxChargeInkWh.

Valores sensatos : 43
currentFuelInLiters

Especifica o fornecimento atual de combustível em litros.

Valores sensíveis : 55
decelerationEfficiency

Especifica a eficiência da conversão de energia cinética em combustível economizado (não consumido) quando o veículo desacelera (ou seja, ChemicalEnergySaved/KineticEnergyLost). ChemicalEnergySaved é obtido convertendo combustível economizado (não consumido) em energia usando fuelEnergyDensityInMJoulesPerLiter.

Deve ser emparelhado com aceleraçãoEficiência.

O intervalo de valores permitidos é de 0,0 a 1/aceleraçãoEficiência.

Valores sensíveis: para modelo de combustão: 0,83, para modelo elétrico: 0,91
departAt

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

Especifica a eficiência da conversão de energia potencial em combustível economizado (não consumido) quando o veículo perde de elevação (ou seja, ChemicalEnergySaved/PotentialEnergyLost). ChemicalEnergySaved é obtido convertendo combustível economizado (não consumido) em energia usando fuelEnergyDensityInMJoulesPerLiter.

Deve ser emparelhado com uphillEfficiency.

O intervalo de valores permitidos é de 0,0 a 1/uphillEfficiency.

Valores sensíveis: para modelo de combustão: 0,51, para modelo elétrico: 0,73
fuelEnergyDensityInMJoulesPerLiter

Especifica a quantidade de energia química armazenada em um litro de combustível em megajoules (MJ). É utilizado em conjunto com os parâmetros *Efficiency para conversões entre energia e combustível poupados ou consumidos. Por exemplo, a densidade de energia é de 34,2 MJ/l para a gasolina e 35,8 MJ/l para o gasóleo.

Este parâmetro é necessário se qualquer parâmetro *Efficiency estiver definido.

Valores sensíveis : 34,2
hilliness

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

Se especificado, as instruções de orientação serão devolvidas. Observe que o parâmetro instructionsType não pode ser usado em conjunto com routeRepresentation=none.
language

O parâmetro language determina o idioma das mensagens de orientação. Os nomes próprios (os nomes das ruas, praças, etc.) são devolvidos na língua especificada ou, se esta não estiver disponível, são devolvidos numa língua disponível que esteja próxima da mesma. Os valores permitidos são (um subconjunto de) as tags de idioma IETF. Os idiomas suportados atualmente estão listados na seção Idiomas suportados .

Valor padrão: en-GB
maxAlternatives

Número de rotas alternativas desejadas a serem calculadas. Padrão: 0, mínimo: 0 e máximo: 5
maxChargeInkWh

Especifica o fornecimento máximo de energia elétrica em quilowatts-hora (kWh) que pode ser armazenada na bateria do veículo.

Este parâmetro coexiste com parâmetro currentChargeInkWh.

O valor mínimo tem de ser maior ou igual a currentChargeInkWh.

Valores sensíveis : 85
minDeviationDistance

Todas as rotas alternativas devolvidas seguirão a rota de referência (ver secção Pedidos POST) a partir do ponto de origem do pedido calculateRoute para, pelo menos, este número de metros. Só pode ser usado ao reconstruir uma rota. O parâmetro minDeviationDistance não pode ser usado em conjunto com arriveAt
minDeviationTime

Todas as rotas alternativas retornadas seguirão a rota de referência (consulte a seção Solicitações POST) a partir do ponto de origem da solicitação calculateRoute por pelo menos esse número de segundos. Só pode ser usado ao reconstruir uma rota. O parâmetro minDeviationTime não pode ser usado em conjunto com arriveAt. O valor padrão é 0. Definir )minDeviationTime_ para um valor maior que zero tem as seguintes consequências:

  • O ponto de origem do calculateRoute Request deve estar na rota de referência de entrada (ou muito próxima).
    • Se este não for o caso, um erro será retornado.
    • No entanto, o ponto de origem não precisa estar no início da rota de referência de entrada (pode ser considerado como a posição atual do veículo na rota de referência).
  • A rota de referência, retornada como a primeira rota no calculateRoute Response, começará no ponto de origem especificado no calculateRoute Request. A parte inicial da rota de referência de entrada até o ponto de origem será excluída da Resposta.
  • Os valores de minDeviationDistance e minDeviationTime determinar até que ponto rotas alternativas serão garantidas para seguir a rota de referência a partir do ponto de origem.
  • A rota deve usar partirEm.
  • O vehicleHeading é ignorado.
query

As coordenadas através das quais a rota é calculada, delimitadas por dois pontos. É necessário um mínimo de duas coordenadas. O primeiro é a origem e o último é o destino da rota. Coordenadas opcionais intermediárias atuam como WayPoints na rota. Você pode passar até 150 WayPoints.
report

Especifica quais dados devem ser relatados para fins de diagnóstico. O único valor possível é effectiveSettings. Relata os parâmetros ou dados efetivos usados ao chamar a API. No caso de parâmetros padrão, o padrão será refletido onde o parâmetro não foi especificado pelo chamador.
routeRepresentation

Especifica a representação do conjunto de rotas fornecidas como resposta.
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
traffic

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

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

Especifica a eficiência da conversão da energia química armazenada no combustível em energia potencial quando o veículo ganha de elevação (ou seja, PotentialEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed é obtido convertendo combustível consumido em energia química usando fuelEnergyDensityInMJoulesPerLiter.

Deve ser emparelhado com downhillEfficiency.

O intervalo de valores permitidos são de 0,0 a 1/downhillEfficiency.

Valores sensíveis: para modelo de combustão: 0,27, para modelo elétrico: 0,74
vehicleAxleWeight

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

Se o veículo é utilizado para fins comerciais. Os veículos comerciais podem não ser autorizados a circular em algumas estradas.
vehicleEngineType

Tipo de motor do veículo. Quando um modelo de consumo detalhado é especificado, ele deve ser consistente com o valor de vehicleEngineType.
vehicleHeading

A direção direcional do veículo em graus, começando no verdadeiro norte e continuando no sentido horário. Norte é de 0 graus, leste é de 90 graus, sul é de 180 graus, oeste é de 270 graus. Valores possíveis 0-359
vehicleHeight

Altura do veículo em metros. Um valor 0 significa que as restrições de altura não são consideradas.
vehicleLength

Comprimento do veículo em metros. Um valor de 0 significa que as restrições de comprimento não são consideradas.
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

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

Peso do veículo em quilogramas.

  • É obrigatório se algum dos parâmetros *Eficiência for definido.

  • Deve ser estritamente positivo quando utilizado no contexto do Modelo de Consumo. Restrições de peso são consideradas.

  • Se não for especificado um detalhado do Modelo de Consumo de e o valor de de peso do veículo for diferente de zero, as restrições de peso serão consideradas.

  • Em todos os outros casos, esse parâmetro é ignorado.

Valores sensíveis: para modelo de combustão: 1600, para modelo elétrico: 1900
vehicleWidth

Largura do veículo em metros. Um valor de 0 significa que as restrições de largura não são consideradas.
windingness

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

Detalhes de Propriedade

accelerationEfficiency

Especifica a eficiência da conversão da energia química armazenada no combustível em energia cinética quando o veículo acelera (ou seja, KineticEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed é obtido convertendo combustível consumido em energia química usando fuelEnergyDensityInMJoulesPerLiter.

Deve ser emparelhado com desaceleraçãoEficiência.

O intervalo de valores permitidos são de 0,0 a 1/desaceleraçãoEficiência.

Valores sensíveis: para modelo de combustão: 0,33, para modelo elétrico: 0,66

accelerationEfficiency?: number

Valor de Propriedade

number

alternativeType

Controla a otimização, em relação aos critérios de planeamento fornecidos, das alternativas calculadas em comparação com a rota de referência.

alternativeType?: "anyRoute" | "betterRoute"

Valor de Propriedade

"anyRoute" | "betterRoute"

arriveAt

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.

arriveAt?: string | Date

Valor de Propriedade

string | Date

auxiliaryPowerInkW

Especifica a quantidade de energia consumida para sustentar sistemas auxiliares, em quilowatts (kW).

Ele pode ser usado para especificar o consumo devido a dispositivos e sistemas, como sistemas de CA, rádio, aquecimento, etc.

Valores sensíveis : 1.7

auxiliaryPowerInkW?: number

Valor de Propriedade

number

auxiliaryPowerInLitersPerHour

Especifica a quantidade de combustível consumida para sustentar os sistemas auxiliares do veículo, em litros por hora.

Ele pode ser usado para especificar o consumo devido a dispositivos e sistemas, como sistemas de CA, rádio, aquecimento, etc.

Valores sensíveis : 0.2

auxiliaryPowerInLitersPerHour?: number

Valor de Propriedade

number

avoid

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.

avoid?: ("tollRoads" | "motorways" | "ferries" | "unpavedRoads" | "carpools" | "alreadyUsedRoads" | "borderCrossings")[]

Valor de Propriedade

("tollRoads" | "motorways" | "ferries" | "unpavedRoads" | "carpools" | "alreadyUsedRoads" | "borderCrossings")[]

computeBestOrder

Reordene os waypoints de rota usando um algoritmo heurístico rápido para reduzir o comprimento da rota. Produz melhores resultados quando usado em conjunto com routeType mais curto. Observe que origem e destino são excluídos dos índices de waypoint otimizados. Para incluir origem e destino na resposta, aumente todos os índices em 1 para levar em conta a origem e, em seguida, adicione o destino como o índice final. Os valores possíveis são true ou false. True calcula uma ordem melhor, se possível, mas não pode ser usado em conjunto com o valor maxAlternatives maior que 0 ou em conjunto com waypoints circulares. False usará os locais na ordem dada e não poderá ser usado em conjunto com routeRepresentation nenhum.

computeBestOrder?: boolean

Valor de Propriedade

boolean

computeTravelTimeFor

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.

computeTravelTimeFor?: "none" | "all"

Valor de Propriedade

"none" | "all"

constantSpeedConsumptionInkWhPerHundredkm

Especifica o componente dependente da velocidade do consumo.

Fornecido como uma lista não ordenada de pares de velocidade/taxa de consumo. A lista define pontos em uma curva de consumo. As taxas de consumo para velocidades que não constam da lista são as seguintes:

  • por interpolação linear, se a velocidade indicada estiver compreendida entre duas velocidades na lista

  • por extrapolação linear caso contrário, pressupondo uma constante (ΔConsumption/ΔSpeed) determinada pelos dois pontos mais próximos da lista

A lista deve conter entre 1 e 25 pontos (inclusive) e não pode conter pontos duplicados para a mesma velocidade. Se contiver apenas um único ponto, a taxa de consumo desse ponto é utilizada sem processamento adicional.

O consumo especificado para a velocidade maior deve ser igual ou superior ao da penúltima velocidade maior. Desta forma, garante-se que a extrapolação não conduza a taxas de consumo negativas.

Do mesmo modo, os valores de consumo especificados para as duas velocidades mais pequenas da lista não podem conduzir a uma taxa de consumo negativa para qualquer velocidade inferior.

O intervalo válido para os valores de consumo (expresso em kWh/100km) situa-se entre 0,01 e 100000,0.

Valores sensíveis : 50,8.2:130,21.3

Este parâmetro é necessário para modelo de consumo elétrico.

constantSpeedConsumptionInkWhPerHundredkm?: string

Valor de Propriedade

string

constantSpeedConsumptionInLitersPerHundredkm

Especifica o componente dependente da velocidade do consumo.

Fornecido como uma lista não ordenada de pares de velocidade & taxa de consumo delimitados por dois pontos. A lista define pontos em uma curva de consumo. As taxas de consumo para velocidades que não constam da lista são as seguintes:

  • por interpolação linear, se a velocidade indicada estiver compreendida entre duas velocidades na lista

  • por extrapolação linear caso contrário, pressupondo uma constante (ΔConsumption/ΔSpeed) determinada pelos dois pontos mais próximos da lista

A lista deve conter entre 1 e 25 pontos (inclusive) e não pode conter pontos duplicados para a mesma velocidade. Se contiver apenas um único ponto, a taxa de consumo desse ponto é utilizada sem processamento adicional.

O consumo especificado para a velocidade maior deve ser igual ou superior ao da penúltima velocidade maior. Desta forma, garante-se que a extrapolação não conduza a taxas de consumo negativas.

Do mesmo modo, os valores de consumo especificados para as duas velocidades mais pequenas da lista não podem conduzir a uma taxa de consumo negativa para qualquer velocidade inferior.

O intervalo válido para os valores de consumo (expresso em l/100km) situa-se entre 0,01 e 100000,0.

Valores sensíveis : 50,6.3:130,11.5

Nota : Este parâmetro é necessário para O Modelo de Consumo de Combustão.

constantSpeedConsumptionInLitersPerHundredkm?: string

Valor de Propriedade

string

currentChargeInkWh

Especifica o fornecimento atual de energia elétrica em quilowatts-hora (kWh).

Este parâmetro coexiste com parâmetro maxChargeInkWh.

O intervalo de valores permitidos é de 0,0 a maxChargeInkWh.

Valores sensatos : 43

currentChargeInkWh?: number

Valor de Propriedade

number

currentFuelInLiters

Especifica o fornecimento atual de combustível em litros.

Valores sensíveis : 55

currentFuelInLiters?: number

Valor de Propriedade

number

decelerationEfficiency

Especifica a eficiência da conversão de energia cinética em combustível economizado (não consumido) quando o veículo desacelera (ou seja, ChemicalEnergySaved/KineticEnergyLost). ChemicalEnergySaved é obtido convertendo combustível economizado (não consumido) em energia usando fuelEnergyDensityInMJoulesPerLiter.

Deve ser emparelhado com aceleraçãoEficiência.

O intervalo de valores permitidos é de 0,0 a 1/aceleraçãoEficiência.

Valores sensíveis: para modelo de combustão: 0,83, para modelo elétrico: 0,91

decelerationEfficiency?: number

Valor de Propriedade

number

departAt

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.

departAt?: string | Date

Valor de Propriedade

string | Date

downhillEfficiency

Especifica a eficiência da conversão de energia potencial em combustível economizado (não consumido) quando o veículo perde de elevação (ou seja, ChemicalEnergySaved/PotentialEnergyLost). ChemicalEnergySaved é obtido convertendo combustível economizado (não consumido) em energia usando fuelEnergyDensityInMJoulesPerLiter.

Deve ser emparelhado com uphillEfficiency.

O intervalo de valores permitidos é de 0,0 a 1/uphillEfficiency.

Valores sensíveis: para modelo de combustão: 0,51, para modelo elétrico: 0,73

downhillEfficiency?: number

Valor de Propriedade

number

fuelEnergyDensityInMJoulesPerLiter

Especifica a quantidade de energia química armazenada em um litro de combustível em megajoules (MJ). É utilizado em conjunto com os parâmetros *Efficiency para conversões entre energia e combustível poupados ou consumidos. Por exemplo, a densidade de energia é de 34,2 MJ/l para a gasolina e 35,8 MJ/l para o gasóleo.

Este parâmetro é necessário se qualquer parâmetro *Efficiency estiver definido.

Valores sensíveis : 34,2

fuelEnergyDensityInMJoulesPerLiter?: number

Valor de Propriedade

number

hilliness

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

hilliness?: "low" | "normal" | "high"

Valor de Propriedade

"low" | "normal" | "high"

instructionsType

Se especificado, as instruções de orientação serão devolvidas. Observe que o parâmetro instructionsType não pode ser usado em conjunto com routeRepresentation=none.

instructionsType?: "coded" | "text" | "tagged"

Valor de Propriedade

"coded" | "text" | "tagged"

language

O parâmetro language determina o idioma das mensagens de orientação. Os nomes próprios (os nomes das ruas, praças, etc.) são devolvidos na língua especificada ou, se esta não estiver disponível, são devolvidos numa língua disponível que esteja próxima da mesma. Os valores permitidos são (um subconjunto de) as tags de idioma IETF. Os idiomas suportados atualmente estão listados na seção Idiomas suportados .

Valor padrão: en-GB

language?: string

Valor de Propriedade

string

maxAlternatives

Número de rotas alternativas desejadas a serem calculadas. Padrão: 0, mínimo: 0 e máximo: 5

maxAlternatives?: number

Valor de Propriedade

number

maxChargeInkWh

Especifica o fornecimento máximo de energia elétrica em quilowatts-hora (kWh) que pode ser armazenada na bateria do veículo.

Este parâmetro coexiste com parâmetro currentChargeInkWh.

O valor mínimo tem de ser maior ou igual a currentChargeInkWh.

Valores sensíveis : 85

maxChargeInkWh?: number

Valor de Propriedade

number

minDeviationDistance

Todas as rotas alternativas devolvidas seguirão a rota de referência (ver secção Pedidos POST) a partir do ponto de origem do pedido calculateRoute para, pelo menos, este número de metros. Só pode ser usado ao reconstruir uma rota. O parâmetro minDeviationDistance não pode ser usado em conjunto com arriveAt

minDeviationDistance?: number

Valor de Propriedade

number

minDeviationTime

Todas as rotas alternativas retornadas seguirão a rota de referência (consulte a seção Solicitações POST) a partir do ponto de origem da solicitação calculateRoute por pelo menos esse número de segundos. Só pode ser usado ao reconstruir uma rota. O parâmetro minDeviationTime não pode ser usado em conjunto com arriveAt. O valor padrão é 0. Definir )minDeviationTime_ para um valor maior que zero tem as seguintes consequências:

  • O ponto de origem do calculateRoute Request deve estar na rota de referência de entrada (ou muito próxima).
    • Se este não for o caso, um erro será retornado.
    • No entanto, o ponto de origem não precisa estar no início da rota de referência de entrada (pode ser considerado como a posição atual do veículo na rota de referência).
  • A rota de referência, retornada como a primeira rota no calculateRoute Response, começará no ponto de origem especificado no calculateRoute Request. A parte inicial da rota de referência de entrada até o ponto de origem será excluída da Resposta.
  • Os valores de minDeviationDistance e minDeviationTime determinar até que ponto rotas alternativas serão garantidas para seguir a rota de referência a partir do ponto de origem.
  • A rota deve usar partirEm.
  • O vehicleHeading é ignorado.
minDeviationTime?: number

Valor de Propriedade

number

query

As coordenadas através das quais a rota é calculada, delimitadas por dois pontos. É necessário um mínimo de duas coordenadas. O primeiro é a origem e o último é o destino da rota. Coordenadas opcionais intermediárias atuam como WayPoints na rota. Você pode passar até 150 WayPoints.

query: string

Valor de Propriedade

string

report

Especifica quais dados devem ser relatados para fins de diagnóstico. O único valor possível é effectiveSettings. Relata os parâmetros ou dados efetivos usados ao chamar a API. No caso de parâmetros padrão, o padrão será refletido onde o parâmetro não foi especificado pelo chamador.

report?: "effectiveSettings"

Valor de Propriedade

"effectiveSettings"

routeRepresentation

Especifica a representação do conjunto de rotas fornecidas como resposta.

routeRepresentation?: "none" | "polyline" | "summaryOnly"

Valor de Propriedade

"none" | "polyline" | "summaryOnly"

routeType

O tipo de rota solicitada.

routeType?: "fastest" | "shortest" | "eco" | "thrilling"

Valor de Propriedade

"fastest" | "shortest" | "eco" | "thrilling"

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

sectionType?: ("carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban")[]

Valor de Propriedade

("carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban")[]

traffic

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.
traffic?: boolean

Valor de Propriedade

boolean

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.

travelMode?: "pedestrian" | "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle"

Valor de Propriedade

"pedestrian" | "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle"

uphillEfficiency

Especifica a eficiência da conversão da energia química armazenada no combustível em energia potencial quando o veículo ganha de elevação (ou seja, PotentialEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed é obtido convertendo combustível consumido em energia química usando fuelEnergyDensityInMJoulesPerLiter.

Deve ser emparelhado com downhillEfficiency.

O intervalo de valores permitidos são de 0,0 a 1/downhillEfficiency.

Valores sensíveis: para modelo de combustão: 0,27, para modelo elétrico: 0,74

uphillEfficiency?: number

Valor de Propriedade

number

vehicleAxleWeight

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.

vehicleAxleWeight?: number

Valor de Propriedade

number

vehicleCommercial

Se o veículo é utilizado para fins comerciais. Os veículos comerciais podem não ser autorizados a circular em algumas estradas.

vehicleCommercial?: boolean

Valor de Propriedade

boolean

vehicleEngineType

Tipo de motor do veículo. Quando um modelo de consumo detalhado é especificado, ele deve ser consistente com o valor de vehicleEngineType.

vehicleEngineType?: "combustion" | "electric"

Valor de Propriedade

"combustion" | "electric"

vehicleHeading

A direção direcional do veículo em graus, começando no verdadeiro norte e continuando no sentido horário. Norte é de 0 graus, leste é de 90 graus, sul é de 180 graus, oeste é de 270 graus. Valores possíveis 0-359

vehicleHeading?: number

Valor de Propriedade

number

vehicleHeight

Altura do veículo em metros. Um valor 0 significa que as restrições de altura não são consideradas.

vehicleHeight?: number

Valor de Propriedade

number

vehicleLength

Comprimento do veículo em metros. Um valor de 0 significa que as restrições de comprimento não são consideradas.

vehicleLength?: number

Valor de Propriedade

number

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.

vehicleLoadType?: "USHazmatClass1" | "USHazmatClass2" | "USHazmatClass3" | "USHazmatClass4" | "USHazmatClass5" | "USHazmatClass6" | "USHazmatClass7" | "USHazmatClass8" | "USHazmatClass9" | "otherHazmatExplosive" | "otherHazmatGeneral" | "otherHazmatHarmfulToWater"

Valor de Propriedade

"USHazmatClass1" | "USHazmatClass2" | "USHazmatClass3" | "USHazmatClass4" | "USHazmatClass5" | "USHazmatClass6" | "USHazmatClass7" | "USHazmatClass8" | "USHazmatClass9" | "otherHazmatExplosive" | "otherHazmatGeneral" | "otherHazmatHarmfulToWater"

vehicleMaxSpeed

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.

vehicleMaxSpeed?: number

Valor de Propriedade

number

vehicleWeight

Peso do veículo em quilogramas.

  • É obrigatório se algum dos parâmetros *Eficiência for definido.

  • Deve ser estritamente positivo quando utilizado no contexto do Modelo de Consumo. Restrições de peso são consideradas.

  • Se não for especificado um detalhado do Modelo de Consumo de e o valor de de peso do veículo for diferente de zero, as restrições de peso serão consideradas.

  • Em todos os outros casos, esse parâmetro é ignorado.

Valores sensíveis: para modelo de combustão: 1600, para modelo elétrico: 1900

vehicleWeight?: number

Valor de Propriedade

number

vehicleWidth

Largura do veículo em metros. Um valor de 0 significa que as restrições de largura não são consideradas.

vehicleWidth?: number

Valor de Propriedade

number

windingness

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

windingness?: "low" | "normal" | "high"

Valor de Propriedade

"low" | "normal" | "high"