Condividi tramite

RouteRequestRouteMatrixQueryParamProperties interface

  • Riferimento
Pacchetto:
@azure-rest/maps-route

Proprietà

arriveAt

Data e ora di arrivo nel punto di destinazione formattato come valore dateTime definito in RFC 3339, sezione 5.6, con una differenza di fuso orario facoltativa. Quando non viene specificata una differenza di fuso orario, si presuppone che sia quella del punto di destinazione.

Esempi:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

Il parametro arriveAt non può essere usato insieme a departAt, minDeviationDistance o minDeviationTime.
avoid

Specifica un elemento che il calcolo della route deve tentare di evitare quando si determina la route. Può essere specificato più volte in una richiesta, ad esempio "&evitare=autostrade&evitare=tollRoads&evitare=traghetti". Nelle richieste di intervallo di route il valore giàUsedRoads non deve essere usato.
computeTravelTimeFor

Specifica se restituire tempi di viaggio aggiuntivi usando tipi diversi di informazioni sul traffico (none, cronologia, dinamica) e il tempo di viaggio migliore predefinito.
departAt

Data e ora di partenza dal punto di origine formattato come valore dateTime definito in RFC 3339, sezione 5.6, con una differenza di fuso orario facoltativa. Quando non viene specificata una differenza di fuso orario, si presuppone che sia quella del punto di origine.

  • Valore predefinito: ora
  • Altro valore: dateTime

Esempi:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

Il parametro departAt non può essere utilizzato insieme a arriveAt.
hilliness

Grado di collina per itinerari emozionanti. Questo parametro può essere usato solo in combinazione con routeType=brivido.
routeType

Tipo di route richiesto.
sectionType

Specifica quale dei tipi di sezione viene segnalato nella risposta di route.

Ad esempio, se sectionType = le sezioni pedonali adatte ai pedoni vengono restituite solo. Può essere specificato più volte in una richiesta, ad esempio '§ionType=carTrain§ionType=pedestrian§ionType=autostrada'. La sezione predefinitaType fa riferimento all'input travelMode. Per impostazione predefinita travelMode è impostato su auto
traffic

Valori possibili:

  • true - Prendere in considerazione tutte le informazioni sul traffico disponibili durante il routing
  • false: ignorare i dati correnti del traffico durante il routing. Si noti che, sebbene i dati di traffico correnti vengano ignorati durante il routing, l'effetto del traffico storico sulle velocità effettive della strada è ancora incorporato.
travelMode

Modalità di viaggio per il percorso richiesto. Se non definito, il valore predefinito è 'car'. Si noti che l'oggetto travelMode richiesto potrebbe non essere disponibile per l'intera route. Se la proprietà travelMode richiesta non è disponibile per una sezione specifica, l'elemento travelMode della risposta per tale sezione sarà "other". Si noti che le modalità di viaggio bus, moto, taxi e furgoni sono funzionalità BETA. I dati di restrizione completi non sono disponibili in tutte le aree.
vehicleAxleWeight

Peso per asse del veicolo in kg. Il valore 0 indica che le restrizioni di peso per asse non vengono considerate.
vehicleHeight

Altezza del veicolo in metri. Il valore 0 indica che le restrizioni di altezza non vengono considerate.
vehicleLength

Lunghezza del veicolo in metri. Il valore 0 indica che le restrizioni di lunghezza non vengono considerate.
vehicleLoadType

Tipi di carico che possono essere classificati come materiali pericolosi e limitati da alcune strade. I valori di vehicleLoadType disponibili sono classi Us Hazmat da 1 a 9, oltre a classificazioni generiche da usare in altri paesi/aree geografiche. I valori che iniziano con USHazmat sono per il routing degli Stati Uniti, mentre altrihazmat devono essere usati per tutti gli altri paesi/aree geografiche. vehicleLoadType può essere specificato più volte. Questo parametro è attualmente considerato solo per travelMode=truck.
vehicleMaxSpeed

Velocità massima del veicolo in km/ora. La velocità massima nel profilo del veicolo viene utilizzata per verificare se un veicolo è consentito sulle autostrade.

  • Il valore 0 indica che un valore appropriato per il veicolo verrà determinato e applicato durante la pianificazione del percorso.

  • È possibile eseguire l'override di un valore diverso da zero durante la pianificazione della route. Ad esempio, il flusso di traffico corrente è di 60 km/ora. Se la velocità massima del veicolo è impostata su 50 km/ora, il motore di instradamento considererà 60 km/ora in quanto si tratta della situazione attuale. Se la velocità massima del veicolo viene fornita come 80 km/ora, ma il flusso di traffico corrente è di 60 km/ora, il motore di instradamento utilizzerà di nuovo 60 km/ora.
vehicleWeight

Peso del veicolo in kg.
vehicleWidth

Larghezza del veicolo in metri. Il valore 0 indica che le restrizioni di larghezza non vengono considerate.
waitForResults

Valore booleano per indicare se eseguire la richiesta in modo sincrono. Se impostato su true, l'utente riceverà una risposta di 200 se la richiesta viene completata in meno di 120 secondi. In caso contrario, l'utente riceverà immediatamente una risposta 202. Per altri dettagli sulla risposta 202, vedere la descrizione dell'API. Supportato solo per la richiesta asincrona.
windingness

Livello di turni per itinerari emozionanti. Questo parametro può essere usato solo in combinazione con routeType=brivido.

Dettagli proprietà

arriveAt

Data e ora di arrivo nel punto di destinazione formattato come valore dateTime definito in RFC 3339, sezione 5.6, con una differenza di fuso orario facoltativa. Quando non viene specificata una differenza di fuso orario, si presuppone che sia quella del punto di destinazione.

Esempi:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

Il parametro arriveAt non può essere usato insieme a departAt, minDeviationDistance o minDeviationTime.

arriveAt?: string | Date

Valore della proprietà

string | Date

avoid

Specifica un elemento che il calcolo della route deve tentare di evitare quando si determina la route. Può essere specificato più volte in una richiesta, ad esempio "&evitare=autostrade&evitare=tollRoads&evitare=traghetti". Nelle richieste di intervallo di route il valore giàUsedRoads non deve essere usato.

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

Valore della proprietà

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

computeTravelTimeFor

Specifica se restituire tempi di viaggio aggiuntivi usando tipi diversi di informazioni sul traffico (none, cronologia, dinamica) e il tempo di viaggio migliore predefinito.

computeTravelTimeFor?: "none" | "all"

Valore della proprietà

"none" | "all"

departAt

Data e ora di partenza dal punto di origine formattato come valore dateTime definito in RFC 3339, sezione 5.6, con una differenza di fuso orario facoltativa. Quando non viene specificata una differenza di fuso orario, si presuppone che sia quella del punto di origine.

  • Valore predefinito: ora
  • Altro valore: dateTime

Esempi:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

Il parametro departAt non può essere utilizzato insieme a arriveAt.

departAt?: string | Date

Valore della proprietà

string | Date

hilliness

Grado di collina per itinerari emozionanti. Questo parametro può essere usato solo in combinazione con routeType=brivido.

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

Valore della proprietà

"low" | "normal" | "high"

routeType

Tipo di route richiesto.

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

Valore della proprietà

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

sectionType

Specifica quale dei tipi di sezione viene segnalato nella risposta di route.

Ad esempio, se sectionType = le sezioni pedonali adatte ai pedoni vengono restituite solo. Può essere specificato più volte in una richiesta, ad esempio '§ionType=carTrain§ionType=pedestrian§ionType=autostrada'. La sezione predefinitaType fa riferimento all'input travelMode. Per impostazione predefinita travelMode è impostato su auto

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

Valore della proprietà

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

traffic

Valori possibili:

  • true - Prendere in considerazione tutte le informazioni sul traffico disponibili durante il routing
  • false: ignorare i dati correnti del traffico durante il routing. Si noti che, sebbene i dati di traffico correnti vengano ignorati durante il routing, l'effetto del traffico storico sulle velocità effettive della strada è ancora incorporato.
traffic?: boolean

Valore della proprietà

boolean

travelMode

Modalità di viaggio per il percorso richiesto. Se non definito, il valore predefinito è 'car'. Si noti che l'oggetto travelMode richiesto potrebbe non essere disponibile per l'intera route. Se la proprietà travelMode richiesta non è disponibile per una sezione specifica, l'elemento travelMode della risposta per tale sezione sarà "other". Si noti che le modalità di viaggio bus, moto, taxi e furgoni sono funzionalità BETA. I dati di restrizione completi non sono disponibili in tutte le aree.

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

Valore della proprietà

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

vehicleAxleWeight

Peso per asse del veicolo in kg. Il valore 0 indica che le restrizioni di peso per asse non vengono considerate.

vehicleAxleWeight?: number

Valore della proprietà

number

vehicleHeight

Altezza del veicolo in metri. Il valore 0 indica che le restrizioni di altezza non vengono considerate.

vehicleHeight?: number

Valore della proprietà

number

vehicleLength

Lunghezza del veicolo in metri. Il valore 0 indica che le restrizioni di lunghezza non vengono considerate.

vehicleLength?: number

Valore della proprietà

number

vehicleLoadType

Tipi di carico che possono essere classificati come materiali pericolosi e limitati da alcune strade. I valori di vehicleLoadType disponibili sono classi Us Hazmat da 1 a 9, oltre a classificazioni generiche da usare in altri paesi/aree geografiche. I valori che iniziano con USHazmat sono per il routing degli Stati Uniti, mentre altrihazmat devono essere usati per tutti gli altri paesi/aree geografiche. vehicleLoadType può essere specificato più volte. Questo parametro è attualmente considerato solo per travelMode=truck.

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

Valore della proprietà

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

vehicleMaxSpeed

Velocità massima del veicolo in km/ora. La velocità massima nel profilo del veicolo viene utilizzata per verificare se un veicolo è consentito sulle autostrade.

  • Il valore 0 indica che un valore appropriato per il veicolo verrà determinato e applicato durante la pianificazione del percorso.

  • È possibile eseguire l'override di un valore diverso da zero durante la pianificazione della route. Ad esempio, il flusso di traffico corrente è di 60 km/ora. Se la velocità massima del veicolo è impostata su 50 km/ora, il motore di instradamento considererà 60 km/ora in quanto si tratta della situazione attuale. Se la velocità massima del veicolo viene fornita come 80 km/ora, ma il flusso di traffico corrente è di 60 km/ora, il motore di instradamento utilizzerà di nuovo 60 km/ora.

vehicleMaxSpeed?: number

Valore della proprietà

number

vehicleWeight

Peso del veicolo in kg.

vehicleWeight?: number

Valore della proprietà

number

vehicleWidth

Larghezza del veicolo in metri. Il valore 0 indica che le restrizioni di larghezza non vengono considerate.

vehicleWidth?: number

Valore della proprietà

number

waitForResults

Valore booleano per indicare se eseguire la richiesta in modo sincrono. Se impostato su true, l'utente riceverà una risposta di 200 se la richiesta viene completata in meno di 120 secondi. In caso contrario, l'utente riceverà immediatamente una risposta 202. Per altri dettagli sulla risposta 202, vedere la descrizione dell'API. Supportato solo per la richiesta asincrona.

waitForResults?: boolean

Valore della proprietà

boolean

windingness

Livello di turni per itinerari emozionanti. Questo parametro può essere usato solo in combinazione con routeType=brivido.

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

Valore della proprietà

"low" | "normal" | "high"