RouteGetRouteDirectionsQueryParamProperties interface

Pacote:

@azure-rest/maps-route

Propriedades

accelerationEfficiency	Especifica a eficiência da conversão de energia química armazenada em combustível em energia cinética quando o veículo acelera (ou seja, KineticEnergyGained/ChemicalEnergyConsumed). O ChemicalEnergyConsumed é obtido convertendo combustível consumido em energia química usando fuelEnergyDensityInMJoulesPerLiter. Deve ser emparelhado com decelerationEfficiency. O intervalo de valores permitidos é de 0,0 a 1/decelerationEfficiency. Valores sensatos: 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 planejamento determinados, das alternativas calculadas em comparação com a rota de referência.
arriveAt	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.
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 AC, rádio, aquecimento etc. Valores sensatos: 1,7
auxiliaryPowerInLitersPerHour	Especifica a quantidade de combustível consumida para manutenção de sistemas auxiliares do veículo, em litros por hora. Ele pode ser usado para especificar o consumo devido a dispositivos e sistemas como sistemas AC, rádio, aquecimento etc. Valores sensatos: 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 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.
computeBestOrder	Solicite novamente os pontos de passagem de rota usando um algoritmo heurístico rápido para reduzir o comprimento da rota. Gera melhores resultados quando usado em conjunto com routeType mais curto. Observe que a origem e o destino são excluídos dos índices de ponto de passagem otimizados. Para incluir a origem e o destino na resposta, aumente todos os índices em 1 para considerar a origem e adicione o destino como o índice final. Os valores possíveis são verdadeiros ou falsos. True calcula uma ordem melhor se possível, mas não é permitido ser usado em conjunto com o valor maxAlternatives maior que 0 ou em conjunto com pontos de passagem de círculo. False usará os locais na ordem fornecida e não poderá ser usado em conjunto com routeRepresentation nenhum.
computeTravelTimeFor	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.
constantSpeedConsumptionInkWhPerHundredkm	Especifica o componente dependente de velocidade do consumo. Fornecida 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 estão na lista são encontradas da seguinte maneira: por interpolação linear, se a velocidade determinada estiver entre duas velocidades na lista por extrapolação linear caso contrário, supondo uma constante (ΔConsumption/ΔSpeed) determinada pelos dois pontos mais próximos na lista A lista deve conter entre 1 e 25 pontos (inclusive) e pode não conter pontos duplicados para a mesma velocidade. Se ele contiver apenas um ponto, a taxa de consumo desse ponto será usada sem processamento adicional. O consumo especificado para a maior velocidade deve ser maior ou igual ao da penúltima maior velocidade. Isso garante que a extrapolação não leve a taxas de consumo negativas. Da mesma forma, os valores de consumo especificados para as duas menores velocidades da lista não podem levar a uma taxa de consumo negativa para qualquer velocidade menor. O intervalo válido para os valores de consumo (expressos em kWh/100km) está entre 0,01 e 1000000,0. Valores sensatos: 50,8,2:130,21,3 Esse parâmetro é necessário para modelo de consumo elétrico.
constantSpeedConsumptionInLitersPerHundredkm	Especifica o componente dependente de velocidade do consumo. Fornecida como uma lista não ordenada de velocidade delimitada por dois-pontos & pares de taxa de consumo. A lista define pontos em uma curva de consumo. As taxas de consumo para velocidades que não estão na lista são encontradas da seguinte maneira: por interpolação linear, se a velocidade determinada estiver entre duas velocidades na lista por extrapolação linear caso contrário, supondo uma constante (ΔConsumption/ΔSpeed) determinada pelos dois pontos mais próximos na lista A lista deve conter entre 1 e 25 pontos (inclusive) e pode não conter pontos duplicados para a mesma velocidade. Se ele contiver apenas um ponto, a taxa de consumo desse ponto será usada sem processamento adicional. O consumo especificado para a maior velocidade deve ser maior ou igual ao da penúltima maior velocidade. Isso garante que a extrapolação não leve a taxas de consumo negativas. Da mesma forma, os valores de consumo especificados para as duas menores velocidades da lista não podem levar a uma taxa de consumo negativa para qualquer velocidade menor. O intervalo válido para os valores de consumo (expressos em l/100km) está entre 0,01 e 1000000,0. Valores sensatos: 50,6,3:130,11,5 Observação: esse 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). Esse 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 sensatos: 55
decelerationEfficiency	Especifica a eficiência da conversão de energia cinética para o combustível salvo (não consumido) quando o veículo desacelera (ou seja, ChemicalEnergySaved/KineticEnergyLost). ChemicalEnergySaved é obtido convertendo combustível salvo (não consumido) em energia usando fuelEnergyDensityInMJoulesPerLiter. Deve ser emparelhado com de aceleração. O intervalo de valores permitidos é de 0,0 a 1/de aceleração. Valores sensatos: para modelo de combustão: 0,83, para modelo elétrico: 0,91
departAt	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.
downhillEfficiency	Especifica a eficiência da conversão de energia potencial para o combustível salvo (não consumido) quando o veículo perde a elevação (ou seja, ChemicalEnergySaved/PotentialEnergyLost). ChemicalEnergySaved é obtido convertendo combustível salvo (não consumido) em energia usando fuelEnergyDensityInMJoulesPerLiter. Deve ser emparelhado com uphillEfficiency. O intervalo de valores permitidos é de 0,0 a 1/uphillEfficiency. Valores sensatos: 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). Ele é usado em conjunto com os parâmetros *Efficiency para conversões entre energia e combustível salvos ou consumidos. Por exemplo, a densidade de energia é de 34,2 MJ/l para gasolina e 35,8 MJ/l para diesel. Esse parâmetro será necessário se algum parâmetro *Efficiency estiver definido. Valores sensatos: 34.2
hilliness	Grau de colina para uma rota emocionante. Esse parâmetro só pode ser usado em conjunto com routeType=emocionante.
instructionsType	Se especificado, as instruções de diretriz serão retornadas. Observe que o parâmetro instructionsType não pode ser usado em conjunto com routeRepresentation=none.
language	O parâmetro de idioma determina o idioma das mensagens de orientação. Os substantivos adequados (os nomes de ruas, praças etc.) são retornados no idioma especificado ou, se isso não estiver disponível, eles são retornados em um idioma disponível próximo a ele. Os valores permitidos são (um subconjunto de) as marcas de idioma IETF. Os idiomas com suporte no momento estão listados na seção idiomas compatíveis. 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 podem ser armazenados na bateria do veículo. Esse parâmetro coexiste com parâmetro CurrentChargeInkWh. O valor mínimo deve ser maior ou igual a CurrentChargeInkWh . Valores sensatos: 85
minDeviationDistance	Todas as rotas alternativas retornadas seguirão a rota de referência (consulte a seção POST Requests) do ponto de origem da solicitação calculateRoute para pelo menos esse número de medidores. 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 POST Requests) do ponto de origem da solicitação calculateRoute para 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 (ou muito próxima) na rota de referência de entrada. Se esse 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 (ele 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, será iniciada no ponto de origem especificado no calculateRoute Request. A parte inicial da rota de referência de entrada até que o ponto de origem seja excluído da Resposta. Os valores de minDeviationDistance e minDeviationTime determinar até que ponto as rotas alternativas serão garantidas para seguir a rota de referência do ponto de origem em diante. A rota deve usar departAt. O vehicleHeading é ignorado.
query	As Coordenadas pelas quais a rota é calculada, delimitada por dois-pontos. Um mínimo de duas coordenadas é necessário. A primeira é a origem e a última é o destino da rota. As coordenadas opcionais no meio 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 em que 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 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	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	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.
uphillEfficiency	Especifica a eficiência da conversão de energia química armazenada em combustível em energia potencial quando o veículo ganha elevação (ou seja, PotentialEnergyGained/ChemicalEnergyConsumed). O ChemicalEnergyConsumed é obtido convertendo combustível consumido em energia química usando fuelEnergyDensityInMJoulesPerLiter. Deve ser emparelhado com dede . O intervalo de valores permitidos é de 0,0 a 1/de. Valores sensatos: para modelo de combustão: 0,27, para modelo elétrico: 0,74
vehicleAxleWeight	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.
vehicleCommercial	Se o veículo é usado para fins comerciais. Veículos comerciais podem não ter permissão para dirigir 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	O título direcional do veículo em graus começando no verdadeiro Norte e continuando na direção horário. Norte é 0 graus, leste é 90 graus, sul é 180 graus, oeste é 270 graus. Valores possíveis 0-359
vehicleHeight	Altura do veículo em metros. Um valor de 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 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	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	Peso do veículo em quilogramas. É obrigatório se qualquer um dos parâmetros *Efficiency estiver definido. Ele deve ser estritamente positivo quando usado no contexto do Modelo de Consumo. Restrições de peso são consideradas. Se nenhum modelo de consumo detalhado for especificado e o valor de vehicleWeight não for zero, as restrições de peso serão consideradas. Em todos os outros casos, esse parâmetro é ignorado. Valores sensatos: 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. Esse parâmetro só pode ser usado em conjunto com routeType=emocionante.

Detalhes da propriedade

accelerationEfficiency

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

Deve ser emparelhado com decelerationEfficiency.

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

Valores sensatos: para modelo de combustão: 0,33, para modelo elétrico: 0,66

accelerationEfficiency?: number

Valor da propriedade

number

alternativeType

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

alternativeType?: "anyRoute" | "betterRoute"

Valor da propriedade

"anyRoute" | "betterRoute"

arriveAt

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.

arriveAt?: string | Date

Valor da 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 AC, rádio, aquecimento etc.

Valores sensatos: 1,7

auxiliaryPowerInkW?: number

Valor da propriedade

number

auxiliaryPowerInLitersPerHour

Especifica a quantidade de combustível consumida para manutenção de sistemas auxiliares do veículo, em litros por hora.

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

Valores sensatos: 0.2

auxiliaryPowerInLitersPerHour?: number

Valor da 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 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.

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

Valor da propriedade

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

computeBestOrder

Solicite novamente os pontos de passagem de rota usando um algoritmo heurístico rápido para reduzir o comprimento da rota. Gera melhores resultados quando usado em conjunto com routeType mais curto. Observe que a origem e o destino são excluídos dos índices de ponto de passagem otimizados. Para incluir a origem e o destino na resposta, aumente todos os índices em 1 para considerar a origem e adicione o destino como o índice final. Os valores possíveis são verdadeiros ou falsos. True calcula uma ordem melhor se possível, mas não é permitido ser usado em conjunto com o valor maxAlternatives maior que 0 ou em conjunto com pontos de passagem de círculo. False usará os locais na ordem fornecida e não poderá ser usado em conjunto com routeRepresentation nenhum.

computeBestOrder?: boolean

Valor da propriedade

boolean

computeTravelTimeFor

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.

computeTravelTimeFor?: "none" | "all"

Valor da propriedade

"none" | "all"

constantSpeedConsumptionInkWhPerHundredkm

Especifica o componente dependente de velocidade do consumo.

Fornecida 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 estão na lista são encontradas da seguinte maneira:

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

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

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

O consumo especificado para a maior velocidade deve ser maior ou igual ao da penúltima maior velocidade. Isso garante que a extrapolação não leve a taxas de consumo negativas.

Da mesma forma, os valores de consumo especificados para as duas menores velocidades da lista não podem levar a uma taxa de consumo negativa para qualquer velocidade menor.

O intervalo válido para os valores de consumo (expressos em kWh/100km) está entre 0,01 e 1000000,0.

Valores sensatos: 50,8,2:130,21,3

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

constantSpeedConsumptionInkWhPerHundredkm?: string

Valor da propriedade

string

constantSpeedConsumptionInLitersPerHundredkm

Especifica o componente dependente de velocidade do consumo.

Fornecida como uma lista não ordenada de velocidade delimitada por dois-pontos & pares de taxa de consumo. A lista define pontos em uma curva de consumo. As taxas de consumo para velocidades que não estão na lista são encontradas da seguinte maneira:

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

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

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

O consumo especificado para a maior velocidade deve ser maior ou igual ao da penúltima maior velocidade. Isso garante que a extrapolação não leve a taxas de consumo negativas.

Da mesma forma, os valores de consumo especificados para as duas menores velocidades da lista não podem levar a uma taxa de consumo negativa para qualquer velocidade menor.

O intervalo válido para os valores de consumo (expressos em l/100km) está entre 0,01 e 1000000,0.

Valores sensatos: 50,6,3:130,11,5

Observação: esse parâmetro é necessário para o modelo de consumo de combustão.

constantSpeedConsumptionInLitersPerHundredkm?: string

Valor da propriedade

string

currentChargeInkWh

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

Esse parâmetro coexiste com parâmetro maxChargeInkWh.

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

Valores sensatos: 43

currentChargeInkWh?: number

Valor da propriedade

number

currentFuelInLiters

Especifica o fornecimento atual de combustível em litros.

Valores sensatos: 55

currentFuelInLiters?: number

Valor da propriedade

number

decelerationEfficiency

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

Deve ser emparelhado com de aceleração.

O intervalo de valores permitidos é de 0,0 a 1/de aceleração.

Valores sensatos: para modelo de combustão: 0,83, para modelo elétrico: 0,91

decelerationEfficiency?: number

Valor da propriedade

number

departAt

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.

departAt?: string | Date

Valor da propriedade

string | Date

downhillEfficiency

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

Deve ser emparelhado com uphillEfficiency.

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

Valores sensatos: para modelo de combustão: 0,51, para modelo elétrico: 0,73

downhillEfficiency?: number

Valor da propriedade

number

fuelEnergyDensityInMJoulesPerLiter

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

Esse parâmetro será necessário se algum parâmetro *Efficiency estiver definido.

Valores sensatos: 34.2

fuelEnergyDensityInMJoulesPerLiter?: number

Valor da propriedade

number

hilliness

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

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

Valor da propriedade

"low" | "normal" | "high"

instructionsType

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

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

Valor da propriedade

"coded" | "text" | "tagged"

language

O parâmetro de idioma determina o idioma das mensagens de orientação. Os substantivos adequados (os nomes de ruas, praças etc.) são retornados no idioma especificado ou, se isso não estiver disponível, eles são retornados em um idioma disponível próximo a ele. Os valores permitidos são (um subconjunto de) as marcas de idioma IETF. Os idiomas com suporte no momento estão listados na seção idiomas compatíveis.

Valor padrão: en-GB

language?: string

Valor da 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 da propriedade

number

maxChargeInkWh

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

Esse parâmetro coexiste com parâmetro CurrentChargeInkWh.

O valor mínimo deve ser maior ou igual a CurrentChargeInkWh .

Valores sensatos: 85

maxChargeInkWh?: number

Valor da propriedade

number

minDeviationDistance

Todas as rotas alternativas retornadas seguirão a rota de referência (consulte a seção POST Requests) do ponto de origem da solicitação calculateRoute para pelo menos esse número de medidores. Só pode ser usado ao reconstruir uma rota. O parâmetro minDeviationDistance não pode ser usado em conjunto com arriveAt

minDeviationDistance?: number

Valor da propriedade

number

minDeviationTime

Todas as rotas alternativas retornadas seguirão a rota de referência (consulte a seção POST Requests) do ponto de origem da solicitação calculateRoute para 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 (ou muito próxima) na rota de referência de entrada.
  • Se esse 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 (ele 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, será iniciada no ponto de origem especificado no calculateRoute Request. A parte inicial da rota de referência de entrada até que o ponto de origem seja excluído da Resposta.
• Os valores de minDeviationDistance e minDeviationTime determinar até que ponto as rotas alternativas serão garantidas para seguir a rota de referência do ponto de origem em diante.
• A rota deve usar departAt.
• O vehicleHeading é ignorado.

minDeviationTime?: number

Valor da propriedade

number

query

As Coordenadas pelas quais a rota é calculada, delimitada por dois-pontos. Um mínimo de duas coordenadas é necessário. A primeira é a origem e a última é o destino da rota. As coordenadas opcionais no meio atuam como WayPoints na rota. Você pode passar até 150 WayPoints.

query: string

Valor da 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 em que o parâmetro não foi especificado pelo chamador.

report?: "effectiveSettings"

Valor da propriedade

"effectiveSettings"

routeRepresentation

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

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

Valor da propriedade

"polyline" | "summaryOnly" | "none"

routeType

O tipo de rota solicitada.

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

Valor da propriedade

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

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

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

Valor da 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 – 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.

traffic?: boolean

Valor da propriedade

boolean

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.

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

Valor da propriedade

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

uphillEfficiency

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

Deve ser emparelhado com dede .

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

Valores sensatos: para modelo de combustão: 0,27, para modelo elétrico: 0,74

uphillEfficiency?: number

Valor da propriedade

number

vehicleAxleWeight

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.

vehicleAxleWeight?: number

Valor da propriedade

number

vehicleCommercial

Se o veículo é usado para fins comerciais. Veículos comerciais podem não ter permissão para dirigir em algumas estradas.

vehicleCommercial?: boolean

Valor da 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 da propriedade

"combustion" | "electric"

vehicleHeading

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

vehicleHeading?: number

Valor da propriedade

number

vehicleHeight

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

vehicleHeight?: number

Valor da 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 da propriedade

number

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.

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

Valor da 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 é 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.

vehicleMaxSpeed?: number

Valor da propriedade

number

vehicleWeight

Peso do veículo em quilogramas.

• É obrigatório se qualquer um dos parâmetros *Efficiency estiver definido.

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

• Se nenhum modelo de consumo detalhado for especificado e o valor de vehicleWeight não for zero, as restrições de peso serão consideradas.

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

Valores sensatos: para modelo de combustão: 1600, para modelo elétrico: 1900

vehicleWeight?: number

Valor da 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 da propriedade

number

windingness

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

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

Valor da propriedade

"low" | "normal" | "high"