Compartilhar via

RouteRequestRouteMatrixSyncQueryParamProperties interface

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

Propriedades

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

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

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

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

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

Detalhes da propriedade

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

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")[]

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"

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

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"

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"

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

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.

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

waitForResults

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.

waitForResults?: boolean

Valor da propriedade

boolean

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"