RouteRequestRouteMatrixSyncQueryParamProperties interface
Propriedades
| arrive |
A data e a hora de chegada ao ponto de destino formatadas como um valor de Exemplos:
O parâmetro |
| 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. |
| compute |
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. |
| depart |
A data e hora de partida do ponto de origem formatado como um valor de
Exemplos:
O parâmetro |
| hilliness | Grau de acidez para uma rota emocionante. Este parâmetro só pode ser usado em conjunto com |
| route |
O tipo de rota solicitada. |
| section |
Especifica qual dos tipos de seção é relatado na resposta da rota. |
| traffic | Valores possíveis:
|
| travel |
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. |
| vehicle |
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. |
| vehicle |
Altura do veículo em metros. Um valor 0 significa que as restrições de altura não são consideradas. |
| vehicle |
Comprimento do veículo em metros. Um valor de 0 significa que as restrições de comprimento não são consideradas. |
| vehicle |
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. |
| vehicle |
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.
|
| vehicle |
Peso do veículo em quilogramas. |
| vehicle |
Largura do veículo em metros. Um valor de 0 significa que as restrições de largura não são consideradas. |
| wait |
Booleano para indicar se a solicitação deve ser executada de forma síncrona. Se definido como true, o usuário receberá uma resposta 200 se a solicitação for concluída em menos de 120 segundos. Caso contrário, o usuário receberá uma resposta 202 imediatamente. Consulte a descrição da API para obter mais detalhes sobre a resposta 202. Suportado apenas para solicitação assíncrona. |
| windingness | Nível de voltas para uma rota emocionante. Este parâmetro só pode ser usado em conjunto com |
Detalhes de Propriedade
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
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")[]
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"
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
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"
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"
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
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.
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
waitForResults
Booleano para indicar se a solicitação deve ser executada de forma síncrona. Se definido como true, o usuário receberá uma resposta 200 se a solicitação for concluída em menos de 120 segundos. Caso contrário, o usuário receberá uma resposta 202 imediatamente. Consulte a descrição da API para obter mais detalhes sobre a resposta 202. Suportado apenas para solicitação assíncrona.
waitForResults?: boolean
Valor de Propriedade
boolean
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"