Dela via

RouteRequestRouteMatrixSyncQueryParamProperties interface

  • Referens
Paket:
@azure-rest/maps-route

Egenskaper

arriveAt

Datum och tid för ankomst till målpunkten formaterat som ett dateTime värde enligt definitionen i RFC 3339, avsnitt 5.6, med en valfri tidszonsförskjutning. När en tidszonsförskjutning inte har angetts antas det vara målpunktens.

Exempel:

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

Parametern arriveAt kan inte användas tillsammans med departAt, minDeviationDistance eller minDeviationTime.
avoid

Anger något som vägberäkningen ska försöka undvika när du bestämmer vägen. Kan anges flera gånger i en begäran, till exempel "&avoid=motorways&avoid=tollRoads&avoid=ferries". I Begäranden om routningsintervall får värdet alreadyUsedRoads inte användas.
computeTravelTimeFor

Anger om du vill returnera ytterligare restider med hjälp av olika typer av trafikinformation (ingen, historisk, live) samt bästa möjliga restid.
departAt

Datum och tid för avresa från ursprungspunkten formaterat som ett dateTime värde enligt definitionen i RFC 3339, avsnitt 5.6, med en valfri tidszonsförskjutning. När en tidszonsförskjutning inte har angetts antas det vara ursprungspunktens.

  • Standardvärde: nu
  • Annat värde: dateTime

Exempel:

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

Parametern departAt kan inte användas tillsammans med arriveAt.
hilliness

Grad av bergighet för spännande väg. Den här parametern kan endast användas tillsammans med routeType=spännande.
routeType

Den typ av väg som begärs.
sectionType

Anger vilken av avsnittstyperna som rapporteras i vägsvaret.

Till exempel om sectionType = fotgängare delar upp, som lämpar sig endast för fotgängare, gås tillbaka. Kan anges flera gånger i en begäran, till exempel "§ionType=carTrain§ionType=pedestrian§ionType=motorway". Standardavsnitttypen refererar till travelMode-indata. Som standard är travelMode inställt på bil
traffic

Möjliga värden:

  • true – Ta hänsyn till all tillgänglig trafikinformation under routning
  • false – Ignorera aktuella trafikdata under routning. Observera att även om aktuella trafikdata ignoreras under routningen, införlivas fortfarande effekten av historisk trafik på effektiva väghastigheter.
travelMode

Färdsätt för den begärda vägen. Om den inte har definierats är standardvärdet "bil". Observera att den begärda travelMode kanske inte är tillgänglig för hela vägen. Om den begärda travelMode inte är tillgänglig för ett visst avsnitt, kommer travelMode-elementet i svaret för det avsnittet att vara "annat". Observera att reselägen buss, motorcykel, taxi och van är BETA-funktioner. Fullständiga begränsningsdata är inte tillgängliga i alla områden.
vehicleAxleWeight

Fordonets vikt per axel i kg. Värdet 0 innebär att viktbegränsningar per axel inte beaktas.
vehicleHeight

Fordonets höjd i meter. Värdet 0 innebär att höjdbegränsningar inte beaktas.
vehicleLength

Fordonets längd i meter. Värdet 0 innebär att längdbegränsningar inte beaktas.
vehicleLoadType

Typer av last som kan klassificeras som farliga material och som är begränsade från vissa vägar. Tillgängliga vehicleLoadType-värden är AMERIKANSKA Hazmat-klasser 1 till 9, plus generiska klassificeringar för användning i andra länder/regioner. Värden som börjar med USHazmat är för USA-routning medan otherHazmat ska användas för alla andra länder/regioner. vehicleLoadType kan anges flera gånger. Den här parametern beaktas för närvarande endast för travelMode=truck.
vehicleMaxSpeed

Fordonets högsta hastighet i km/timme. Maxhastigheten i fordonsprofilen används för att kontrollera om ett fordon tillåts på motorvägar.

  • Värdet 0 innebär att ett lämpligt värde för fordonet bestäms och tillämpas under ruttplaneringen.

  • Ett värde som inte är noll kan åsidosättas under routningsplaneringen. Det aktuella trafikflödet är till exempel 60 km/timme. Om fordonets högsta hastighet är inställd på 50 km/timme kommer routningsmotorn att överväga 60 km/timme eftersom detta är den aktuella situationen. Om fordonets högsta hastighet anges som 80 km/timme, men det aktuella trafikflödet är 60 km/timme, använder routningsmotorn återigen 60 km/timme.
vehicleWeight

Fordonets vikt i kg.
vehicleWidth

Fordonets bredd i meter. Värdet 0 innebär att breddbegränsningar inte beaktas.
waitForResults

Booleskt värde för att ange om begäran ska köras synkront. Om värdet är true får användaren ett svar på 200 om begäran har slutförts under 120 sekunder. Annars får användaren ett 202-svar direkt. Mer information om 202-svaret finns i API-beskrivningen. stöds endast för asynkron begäran.
windingness

Nivå av svängar för spännande rutt. Den här parametern kan endast användas tillsammans med routeType=spännande.

Egenskapsinformation

arriveAt

Datum och tid för ankomst till målpunkten formaterat som ett dateTime värde enligt definitionen i RFC 3339, avsnitt 5.6, med en valfri tidszonsförskjutning. När en tidszonsförskjutning inte har angetts antas det vara målpunktens.

Exempel:

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

Parametern arriveAt kan inte användas tillsammans med departAt, minDeviationDistance eller minDeviationTime.

arriveAt?: string | Date

Egenskapsvärde

string | Date

avoid

Anger något som vägberäkningen ska försöka undvika när du bestämmer vägen. Kan anges flera gånger i en begäran, till exempel "&avoid=motorways&avoid=tollRoads&avoid=ferries". I Begäranden om routningsintervall får värdet alreadyUsedRoads inte användas.

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

Egenskapsvärde

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

computeTravelTimeFor

Anger om du vill returnera ytterligare restider med hjälp av olika typer av trafikinformation (ingen, historisk, live) samt bästa möjliga restid.

computeTravelTimeFor?: "none" | "all"

Egenskapsvärde

"none" | "all"

departAt

Datum och tid för avresa från ursprungspunkten formaterat som ett dateTime värde enligt definitionen i RFC 3339, avsnitt 5.6, med en valfri tidszonsförskjutning. När en tidszonsförskjutning inte har angetts antas det vara ursprungspunktens.

  • Standardvärde: nu
  • Annat värde: dateTime

Exempel:

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

Parametern departAt kan inte användas tillsammans med arriveAt.

departAt?: string | Date

Egenskapsvärde

string | Date

hilliness

Grad av bergighet för spännande väg. Den här parametern kan endast användas tillsammans med routeType=spännande.

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

Egenskapsvärde

"low" | "normal" | "high"

routeType

Den typ av väg som begärs.

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

Egenskapsvärde

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

sectionType

Anger vilken av avsnittstyperna som rapporteras i vägsvaret.

Till exempel om sectionType = fotgängare delar upp, som lämpar sig endast för fotgängare, gås tillbaka. Kan anges flera gånger i en begäran, till exempel "§ionType=carTrain§ionType=pedestrian§ionType=motorway". Standardavsnitttypen refererar till travelMode-indata. Som standard är travelMode inställt på bil

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

Egenskapsvärde

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

traffic

Möjliga värden:

  • true – Ta hänsyn till all tillgänglig trafikinformation under routning
  • false – Ignorera aktuella trafikdata under routning. Observera att även om aktuella trafikdata ignoreras under routningen, införlivas fortfarande effekten av historisk trafik på effektiva väghastigheter.
traffic?: boolean

Egenskapsvärde

boolean

travelMode

Färdsätt för den begärda vägen. Om den inte har definierats är standardvärdet "bil". Observera att den begärda travelMode kanske inte är tillgänglig för hela vägen. Om den begärda travelMode inte är tillgänglig för ett visst avsnitt, kommer travelMode-elementet i svaret för det avsnittet att vara "annat". Observera att reselägen buss, motorcykel, taxi och van är BETA-funktioner. Fullständiga begränsningsdata är inte tillgängliga i alla områden.

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

Egenskapsvärde

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

vehicleAxleWeight

Fordonets vikt per axel i kg. Värdet 0 innebär att viktbegränsningar per axel inte beaktas.

vehicleAxleWeight?: number

Egenskapsvärde

number

vehicleHeight

Fordonets höjd i meter. Värdet 0 innebär att höjdbegränsningar inte beaktas.

vehicleHeight?: number

Egenskapsvärde

number

vehicleLength

Fordonets längd i meter. Värdet 0 innebär att längdbegränsningar inte beaktas.

vehicleLength?: number

Egenskapsvärde

number

vehicleLoadType

Typer av last som kan klassificeras som farliga material och som är begränsade från vissa vägar. Tillgängliga vehicleLoadType-värden är AMERIKANSKA Hazmat-klasser 1 till 9, plus generiska klassificeringar för användning i andra länder/regioner. Värden som börjar med USHazmat är för USA-routning medan otherHazmat ska användas för alla andra länder/regioner. vehicleLoadType kan anges flera gånger. Den här parametern beaktas för närvarande endast för travelMode=truck.

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

Egenskapsvärde

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

vehicleMaxSpeed

Fordonets högsta hastighet i km/timme. Maxhastigheten i fordonsprofilen används för att kontrollera om ett fordon tillåts på motorvägar.

  • Värdet 0 innebär att ett lämpligt värde för fordonet bestäms och tillämpas under ruttplaneringen.

  • Ett värde som inte är noll kan åsidosättas under routningsplaneringen. Det aktuella trafikflödet är till exempel 60 km/timme. Om fordonets högsta hastighet är inställd på 50 km/timme kommer routningsmotorn att överväga 60 km/timme eftersom detta är den aktuella situationen. Om fordonets högsta hastighet anges som 80 km/timme, men det aktuella trafikflödet är 60 km/timme, använder routningsmotorn återigen 60 km/timme.

vehicleMaxSpeed?: number

Egenskapsvärde

number

vehicleWeight

Fordonets vikt i kg.

vehicleWeight?: number

Egenskapsvärde

number

vehicleWidth

Fordonets bredd i meter. Värdet 0 innebär att breddbegränsningar inte beaktas.

vehicleWidth?: number

Egenskapsvärde

number

waitForResults

Booleskt värde för att ange om begäran ska köras synkront. Om värdet är true får användaren ett svar på 200 om begäran har slutförts under 120 sekunder. Annars får användaren ett 202-svar direkt. Mer information om 202-svaret finns i API-beskrivningen. stöds endast för asynkron begäran.

waitForResults?: boolean

Egenskapsvärde

boolean

windingness

Nivå av svängar för spännande rutt. Den här parametern kan endast användas tillsammans med routeType=spännande.

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

Egenskapsvärde

"low" | "normal" | "high"