Dela via

RouteGetRouteDirectionsQueryParamProperties interface

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

Egenskaper

accelerationEfficiency

Anger effektiviteten vid omvandling av kemisk energi som lagras i bränsle till kinetisk energi när fordonet accelererar (dvs. KineticEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed erhålls genom konvertering av förbrukat bränsle till kemisk energi med hjälp av fuelEnergyDensityInMJoulesPerLiter.

Måste parkopplas med inbromsningEffektivitet.

Tillåtna värden är 0,0 till 1/inbromsningEffektivitet.

Förnuftiga värden: för förbränningsmodell: 0,33, för elektrisk modell: 0,66
alternativeType

Styr optimaliteten, med avseende på de angivna planeringskriterierna, för de beräknade alternativen jämfört med referensvägen.
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.
auxiliaryPowerInkW

Anger hur mycket ström som förbrukas för att underhålla extrasystem i kilowatt (kW).

Det kan användas för att ange förbrukning på grund av enheter och system som AC-system, radio, uppvärmning osv.

Förnuftiga värden: 1.7
auxiliaryPowerInLitersPerHour

Anger mängden bränsle som förbrukas för underhåll av extra system i fordonet, i liter per timme.

Det kan användas för att ange förbrukning på grund av enheter och system som AC-system, radio, uppvärmning osv.

Förnuftiga värden: 0.2
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.
computeBestOrder

Sortera om vägvägspunkterna med hjälp av en snabb heuristisk algoritm för att minska routningslängden. Ger bästa resultat när det används tillsammans med routeType kortaste. Observera att ursprung och mål undantas från de optimerade waypoint-indexen. Om du vill inkludera ursprung och mål i svaret ökar du alla index med 1 för att ta hänsyn till ursprunget och lägger sedan till målet som det slutliga indexet. Möjliga värden är sanna eller falska. True beräknar en bättre ordning om möjligt, men får inte användas tillsammans med maxAlternatives-värdet större än 0 eller tillsammans med cirkelvägpunkter. False använder platserna i den angivna ordningen och får inte användas tillsammans med routeRepresentation ingen.
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.
constantSpeedConsumptionInkWhPerHundredkm

Anger den hastighetsberoende komponenten för förbrukning.

Tillhandahålls som en osorterad lista över hastighets-/förbrukningsfrekvenspar. Listan definierar punkter i en förbrukningskurva. Förbrukningshastigheter för hastigheter som inte finns i listan finns på följande sätt:

  • linjär interpolation, om den angivna hastigheten ligger mellan två hastigheter i listan

  • av linjär extrapolering annars, förutsatt att en konstant (ΔConsumption/ΔSpeed) bestäms av de närmaste två punkterna i listan

Listan måste innehålla mellan 1 och 25 punkter (inklusive) och får inte innehålla dubblettpunkter för samma hastighet. Om den bara innehåller en enda punkt används förbrukningshastigheten för den punkten utan ytterligare bearbetning.

Förbrukning som anges för den största hastigheten måste vara större än eller lika med den näst sista största hastigheten. Detta säkerställer att extrapoleringen inte leder till negativ förbrukning.

På samma sätt kan förbrukningsvärden som anges för de två minsta hastigheterna i listan inte leda till en negativ förbrukningshastighet för någon mindre hastighet.

Det giltiga intervallet för förbrukningsvärdena (uttryckt i kWh/100km) är mellan 0,01 och 100000,0.

Förnuftiga värden: 50,8.2:130,21.3

Den här parametern krävs för Elektrisk förbrukningsmodell.
constantSpeedConsumptionInLitersPerHundredkm

Anger den hastighetsberoende komponenten för förbrukning.

Tillhandahålls som en osorterad lista över kolonavgränsade hastighet & förbrukningsfrekvenspar. Listan definierar punkter i en förbrukningskurva. Förbrukningshastigheter för hastigheter som inte finns i listan finns på följande sätt:

  • linjär interpolation, om den angivna hastigheten ligger mellan två hastigheter i listan

  • av linjär extrapolering annars, förutsatt att en konstant (ΔConsumption/ΔSpeed) bestäms av de närmaste två punkterna i listan

Listan måste innehålla mellan 1 och 25 punkter (inklusive) och får inte innehålla dubblettpunkter för samma hastighet. Om den bara innehåller en enda punkt används förbrukningshastigheten för den punkten utan ytterligare bearbetning.

Förbrukning som anges för den största hastigheten måste vara större än eller lika med den näst sista största hastigheten. Detta säkerställer att extrapoleringen inte leder till negativ förbrukning.

På samma sätt kan förbrukningsvärden som anges för de två minsta hastigheterna i listan inte leda till en negativ förbrukningshastighet för någon mindre hastighet.

Det giltiga intervallet för förbrukningsvärdena (uttryckt i l/100km) är mellan 0,01 och 100000,0.

Förnuftiga värden: 50,6.3:130,11.5

Obs : Den här parametern krävs för Förbränningsförbrukningsmodellen.
currentChargeInkWh

Anger den aktuella elenergiförsörjningen i kilowatttimmar (kWh).

Den här parametern finns tillsammans med parametern maxChargeInkWh.

Tillåtna värden är 0,0 till maxChargeInkWh.

Förnuftiga värden: 43
currentFuelInLiters

Anger den aktuella bränsletillförseln i liter.

Förnuftiga värden: 55
decelerationEfficiency

Anger effektiviteten i att omvandla kinetisk energi till sparat (ej förbrukat) bränsle när fordonet saktar in (dvs. ChemicalEnergySaved/KineticEnergyLost). ChemicalEnergySaved erhålls genom konvertering av sparat (ej förbrukat) bränsle till energi med hjälp av fuelEnergyDensityInMJoulesPerLiter.

Måste paras ihop med accelerationEffektivitet.

Tillåtna värden är 0,0 till 1/accelerationEffektivitet.

Förnuftiga värden: för förbränningsmodell: 0,83, för elektrisk modell: 0,91
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.
downhillEfficiency

Anger effektiviteten för att omvandla potentiell energi till sparat (ej förbrukat) bränsle när fordonet förlorar höjd (dvs. ChemicalEnergySaved/PotentialEnergyLost). ChemicalEnergySaved erhålls genom konvertering av sparat (ej förbrukat) bränsle till energi med hjälp av fuelEnergyDensityInMJoulesPerLiter.

Måste parkopplas med .

Tillåtna värden är 0,0 till 1/uppförEffektivitet.

Förnuftiga värden: för förbränningsmodell: 0,51, för elektrisk modell: 0,73
fuelEnergyDensityInMJoulesPerLiter

Anger mängden kemisk energi som lagras i en liter bränsle i megajoule (MJ). Det används tillsammans med parametrarna *Efficiency för konverteringar mellan sparad eller förbrukad energi och bränsle. Energidensiteten är till exempel 34,2 MJ/l för bensin och 35,8 MJ/l för dieselbränsle.

Den här parametern krävs om någon *Efficiency parameter har angetts.

Förnuftiga värden: 34.2
hilliness

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

Om det anges returneras vägledningsinstruktioner. Observera att parametern instructionsType inte kan användas tillsammans med routeRepresentation=none.
language

Språkparametern avgör språket i vägledningsmeddelandena. Lämpliga substantiv (namnen på gator, torg osv.) returneras på det angivna språket, eller om det inte är tillgängligt returneras de på ett tillgängligt språk som ligger nära det. Tillåtna värden är (en delmängd av) IETF-språktaggar. De språk som stöds för närvarande visas i avsnittet språk som stöds.

Standardvärde: en-GB
maxAlternatives

Antal önskade alternativa vägar som ska beräknas. Standard: 0, minimum: 0 och maximum: 5
maxChargeInkWh

Anger den maximala elenergitillförseln i kilowatttimmar (kWh) som kan lagras i fordonets batteri.

Den här parametern finns tillsammans med parametern currentChargeInkWh.

Minimivärdet måste vara större än eller lika med currentChargeInkWh-.

Förnuftiga värden: 85
minDeviationDistance

Alla alternativa vägar som returneras följer referensvägen (se avsnittet POST-begäranden) från ursprungspunkten för calculateRoute-begäran för minst det här antalet mätare. Kan bara användas när du rekonstruerar en väg. Parametern minDeviationDistance kan inte användas tillsammans med arriveAt
minDeviationTime

Alla alternativa vägar som returneras följer referensvägen (se avsnittet POST-begäranden) från startpunkten för calculateRoute-begäran i minst det här antalet sekunder. Kan bara användas när du rekonstruerar en väg. Parametern minDeviationTime kan inte användas tillsammans med arriveAt. Standardvärdet är 0. Om du anger )minDeviationTime_ till ett värde som är större än noll får följande konsekvenser:

  • Ursprungspunkten för calculateRoute Begäran måste finnas på (eller mycket nära) indatareferensvägen.
    • Om så inte är fallet returneras ett fel.
    • Ursprungspunkten behöver dock inte vara i början av referensvägen för indata (den kan betraktas som den aktuella fordonspositionen på referensvägen).
  • Referensvägen, som returneras som den första vägen i calculateRoute Response, startar vid den ursprungspunkt som anges i calculateRoute Request. Den första delen av indatareferensvägen fram till ursprungspunkten undantas från svaret.
  • Värdena för minDeviationDistance och minDeviationTime avgör hur långt alternativa vägar garanteras att följa referensvägen från ursprungspunkten och framåt.
  • Vägen måste använda departAt.
  • vehicleHeading ignoreras.
query

Koordinaterna som vägen beräknas genom, avgränsade med ett kolon. Minst två koordinater krävs. Den första är ursprunget och det sista är vägens mål. Valfria koordinater mellan fungerar som WayPoints i vägen. Du kan skicka upp till 150 WayPoints.
report

Anger vilka data som ska rapporteras i diagnossyfte. Det enda möjliga värdet är effectiveSettings. Rapporterar de effektiva parametrar eller data som används vid anrop till API:et. När det gäller standardparametrar återspeglas standardvärdet där parametern inte angavs av anroparen.
routeRepresentation

Anger representationen av uppsättningen vägar som tillhandahålls som svar.
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.
uphillEfficiency

Anger effektiviteten vid omvandling av kemisk energi som lagras i bränsle till potentiell energi när fordonet ökar (dvs. PotentialEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed erhålls genom konvertering av förbrukat bränsle till kemisk energi med hjälp av fuelEnergyDensityInMJoulesPerLiter.

Måste parkopplas med downhillEfficiency.

Det tillåtna intervallet är 0,0 till 1/downhillEfficiency.

Förnuftiga värden: för förbränningsmodell: 0,27, för elektrisk modell: 0,74
vehicleAxleWeight

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

Om fordonet används i kommersiellt syfte. Nyttofordon får inte köra på vissa vägar.
vehicleEngineType

Fordonets motortyp. När en detaljerad förbrukningsmodell anges måste den vara konsekvent med värdet för vehicleEngineType.
vehicleHeading

Fordonets riktning i grader som börjar på true North och fortsätter i medsols riktning. Norr är 0 grader, öst är 90 grader, söder är 180 grader, väst är 270 grader. Möjliga värden 0–359
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.

  • Det är obligatoriskt om någon av *Effektivitetsparametrarna har angetts.

  • Det måste vara strikt positivt när det används i kontexten för förbrukningsmodellen. Viktbegränsningar beaktas.

  • Om ingen detaljerad förbrukningsmodell anges och värdet för vehicleWeight inte är noll, beaktas viktbegränsningar.

  • I alla andra fall ignoreras den här parametern.

Förnuftiga värden: för förbränningsmodell: 1600, för elektrisk modell : 1900
vehicleWidth

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

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

Egenskapsinformation

accelerationEfficiency

Anger effektiviteten vid omvandling av kemisk energi som lagras i bränsle till kinetisk energi när fordonet accelererar (dvs. KineticEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed erhålls genom konvertering av förbrukat bränsle till kemisk energi med hjälp av fuelEnergyDensityInMJoulesPerLiter.

Måste parkopplas med inbromsningEffektivitet.

Tillåtna värden är 0,0 till 1/inbromsningEffektivitet.

Förnuftiga värden: för förbränningsmodell: 0,33, för elektrisk modell: 0,66

accelerationEfficiency?: number

Egenskapsvärde

number

alternativeType

Styr optimaliteten, med avseende på de angivna planeringskriterierna, för de beräknade alternativen jämfört med referensvägen.

alternativeType?: "anyRoute" | "betterRoute"

Egenskapsvärde

"anyRoute" | "betterRoute"

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

auxiliaryPowerInkW

Anger hur mycket ström som förbrukas för att underhålla extrasystem i kilowatt (kW).

Det kan användas för att ange förbrukning på grund av enheter och system som AC-system, radio, uppvärmning osv.

Förnuftiga värden: 1.7

auxiliaryPowerInkW?: number

Egenskapsvärde

number

auxiliaryPowerInLitersPerHour

Anger mängden bränsle som förbrukas för underhåll av extra system i fordonet, i liter per timme.

Det kan användas för att ange förbrukning på grund av enheter och system som AC-system, radio, uppvärmning osv.

Förnuftiga värden: 0.2

auxiliaryPowerInLitersPerHour?: number

Egenskapsvärde

number

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

computeBestOrder

Sortera om vägvägspunkterna med hjälp av en snabb heuristisk algoritm för att minska routningslängden. Ger bästa resultat när det används tillsammans med routeType kortaste. Observera att ursprung och mål undantas från de optimerade waypoint-indexen. Om du vill inkludera ursprung och mål i svaret ökar du alla index med 1 för att ta hänsyn till ursprunget och lägger sedan till målet som det slutliga indexet. Möjliga värden är sanna eller falska. True beräknar en bättre ordning om möjligt, men får inte användas tillsammans med maxAlternatives-värdet större än 0 eller tillsammans med cirkelvägpunkter. False använder platserna i den angivna ordningen och får inte användas tillsammans med routeRepresentation ingen.

computeBestOrder?: boolean

Egenskapsvärde

boolean

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"

constantSpeedConsumptionInkWhPerHundredkm

Anger den hastighetsberoende komponenten för förbrukning.

Tillhandahålls som en osorterad lista över hastighets-/förbrukningsfrekvenspar. Listan definierar punkter i en förbrukningskurva. Förbrukningshastigheter för hastigheter som inte finns i listan finns på följande sätt:

  • linjär interpolation, om den angivna hastigheten ligger mellan två hastigheter i listan

  • av linjär extrapolering annars, förutsatt att en konstant (ΔConsumption/ΔSpeed) bestäms av de närmaste två punkterna i listan

Listan måste innehålla mellan 1 och 25 punkter (inklusive) och får inte innehålla dubblettpunkter för samma hastighet. Om den bara innehåller en enda punkt används förbrukningshastigheten för den punkten utan ytterligare bearbetning.

Förbrukning som anges för den största hastigheten måste vara större än eller lika med den näst sista största hastigheten. Detta säkerställer att extrapoleringen inte leder till negativ förbrukning.

På samma sätt kan förbrukningsvärden som anges för de två minsta hastigheterna i listan inte leda till en negativ förbrukningshastighet för någon mindre hastighet.

Det giltiga intervallet för förbrukningsvärdena (uttryckt i kWh/100km) är mellan 0,01 och 100000,0.

Förnuftiga värden: 50,8.2:130,21.3

Den här parametern krävs för Elektrisk förbrukningsmodell.

constantSpeedConsumptionInkWhPerHundredkm?: string

Egenskapsvärde

string

constantSpeedConsumptionInLitersPerHundredkm

Anger den hastighetsberoende komponenten för förbrukning.

Tillhandahålls som en osorterad lista över kolonavgränsade hastighet & förbrukningsfrekvenspar. Listan definierar punkter i en förbrukningskurva. Förbrukningshastigheter för hastigheter som inte finns i listan finns på följande sätt:

  • linjär interpolation, om den angivna hastigheten ligger mellan två hastigheter i listan

  • av linjär extrapolering annars, förutsatt att en konstant (ΔConsumption/ΔSpeed) bestäms av de närmaste två punkterna i listan

Listan måste innehålla mellan 1 och 25 punkter (inklusive) och får inte innehålla dubblettpunkter för samma hastighet. Om den bara innehåller en enda punkt används förbrukningshastigheten för den punkten utan ytterligare bearbetning.

Förbrukning som anges för den största hastigheten måste vara större än eller lika med den näst sista största hastigheten. Detta säkerställer att extrapoleringen inte leder till negativ förbrukning.

På samma sätt kan förbrukningsvärden som anges för de två minsta hastigheterna i listan inte leda till en negativ förbrukningshastighet för någon mindre hastighet.

Det giltiga intervallet för förbrukningsvärdena (uttryckt i l/100km) är mellan 0,01 och 100000,0.

Förnuftiga värden: 50,6.3:130,11.5

Obs : Den här parametern krävs för Förbränningsförbrukningsmodellen.

constantSpeedConsumptionInLitersPerHundredkm?: string

Egenskapsvärde

string

currentChargeInkWh

Anger den aktuella elenergiförsörjningen i kilowatttimmar (kWh).

Den här parametern finns tillsammans med parametern maxChargeInkWh.

Tillåtna värden är 0,0 till maxChargeInkWh.

Förnuftiga värden: 43

currentChargeInkWh?: number

Egenskapsvärde

number

currentFuelInLiters

Anger den aktuella bränsletillförseln i liter.

Förnuftiga värden: 55

currentFuelInLiters?: number

Egenskapsvärde

number

decelerationEfficiency

Anger effektiviteten i att omvandla kinetisk energi till sparat (ej förbrukat) bränsle när fordonet saktar in (dvs. ChemicalEnergySaved/KineticEnergyLost). ChemicalEnergySaved erhålls genom konvertering av sparat (ej förbrukat) bränsle till energi med hjälp av fuelEnergyDensityInMJoulesPerLiter.

Måste paras ihop med accelerationEffektivitet.

Tillåtna värden är 0,0 till 1/accelerationEffektivitet.

Förnuftiga värden: för förbränningsmodell: 0,83, för elektrisk modell: 0,91

decelerationEfficiency?: number

Egenskapsvärde

number

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

downhillEfficiency

Anger effektiviteten för att omvandla potentiell energi till sparat (ej förbrukat) bränsle när fordonet förlorar höjd (dvs. ChemicalEnergySaved/PotentialEnergyLost). ChemicalEnergySaved erhålls genom konvertering av sparat (ej förbrukat) bränsle till energi med hjälp av fuelEnergyDensityInMJoulesPerLiter.

Måste parkopplas med .

Tillåtna värden är 0,0 till 1/uppförEffektivitet.

Förnuftiga värden: för förbränningsmodell: 0,51, för elektrisk modell: 0,73

downhillEfficiency?: number

Egenskapsvärde

number

fuelEnergyDensityInMJoulesPerLiter

Anger mängden kemisk energi som lagras i en liter bränsle i megajoule (MJ). Det används tillsammans med parametrarna *Efficiency för konverteringar mellan sparad eller förbrukad energi och bränsle. Energidensiteten är till exempel 34,2 MJ/l för bensin och 35,8 MJ/l för dieselbränsle.

Den här parametern krävs om någon *Efficiency parameter har angetts.

Förnuftiga värden: 34.2

fuelEnergyDensityInMJoulesPerLiter?: number

Egenskapsvärde

number

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"

instructionsType

Om det anges returneras vägledningsinstruktioner. Observera att parametern instructionsType inte kan användas tillsammans med routeRepresentation=none.

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

Egenskapsvärde

"coded" | "text" | "tagged"

language

Språkparametern avgör språket i vägledningsmeddelandena. Lämpliga substantiv (namnen på gator, torg osv.) returneras på det angivna språket, eller om det inte är tillgängligt returneras de på ett tillgängligt språk som ligger nära det. Tillåtna värden är (en delmängd av) IETF-språktaggar. De språk som stöds för närvarande visas i avsnittet språk som stöds.

Standardvärde: en-GB

language?: string

Egenskapsvärde

string

maxAlternatives

Antal önskade alternativa vägar som ska beräknas. Standard: 0, minimum: 0 och maximum: 5

maxAlternatives?: number

Egenskapsvärde

number

maxChargeInkWh

Anger den maximala elenergitillförseln i kilowatttimmar (kWh) som kan lagras i fordonets batteri.

Den här parametern finns tillsammans med parametern currentChargeInkWh.

Minimivärdet måste vara större än eller lika med currentChargeInkWh-.

Förnuftiga värden: 85

maxChargeInkWh?: number

Egenskapsvärde

number

minDeviationDistance

Alla alternativa vägar som returneras följer referensvägen (se avsnittet POST-begäranden) från ursprungspunkten för calculateRoute-begäran för minst det här antalet mätare. Kan bara användas när du rekonstruerar en väg. Parametern minDeviationDistance kan inte användas tillsammans med arriveAt

minDeviationDistance?: number

Egenskapsvärde

number

minDeviationTime

Alla alternativa vägar som returneras följer referensvägen (se avsnittet POST-begäranden) från startpunkten för calculateRoute-begäran i minst det här antalet sekunder. Kan bara användas när du rekonstruerar en väg. Parametern minDeviationTime kan inte användas tillsammans med arriveAt. Standardvärdet är 0. Om du anger )minDeviationTime_ till ett värde som är större än noll får följande konsekvenser:

  • Ursprungspunkten för calculateRoute Begäran måste finnas på (eller mycket nära) indatareferensvägen.
    • Om så inte är fallet returneras ett fel.
    • Ursprungspunkten behöver dock inte vara i början av referensvägen för indata (den kan betraktas som den aktuella fordonspositionen på referensvägen).
  • Referensvägen, som returneras som den första vägen i calculateRoute Response, startar vid den ursprungspunkt som anges i calculateRoute Request. Den första delen av indatareferensvägen fram till ursprungspunkten undantas från svaret.
  • Värdena för minDeviationDistance och minDeviationTime avgör hur långt alternativa vägar garanteras att följa referensvägen från ursprungspunkten och framåt.
  • Vägen måste använda departAt.
  • vehicleHeading ignoreras.
minDeviationTime?: number

Egenskapsvärde

number

query

Koordinaterna som vägen beräknas genom, avgränsade med ett kolon. Minst två koordinater krävs. Den första är ursprunget och det sista är vägens mål. Valfria koordinater mellan fungerar som WayPoints i vägen. Du kan skicka upp till 150 WayPoints.

query: string

Egenskapsvärde

string

report

Anger vilka data som ska rapporteras i diagnossyfte. Det enda möjliga värdet är effectiveSettings. Rapporterar de effektiva parametrar eller data som används vid anrop till API:et. När det gäller standardparametrar återspeglas standardvärdet där parametern inte angavs av anroparen.

report?: "effectiveSettings"

Egenskapsvärde

"effectiveSettings"

routeRepresentation

Anger representationen av uppsättningen vägar som tillhandahålls som svar.

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

Egenskapsvärde

"polyline" | "summaryOnly" | "none"

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"

uphillEfficiency

Anger effektiviteten vid omvandling av kemisk energi som lagras i bränsle till potentiell energi när fordonet ökar (dvs. PotentialEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed erhålls genom konvertering av förbrukat bränsle till kemisk energi med hjälp av fuelEnergyDensityInMJoulesPerLiter.

Måste parkopplas med downhillEfficiency.

Det tillåtna intervallet är 0,0 till 1/downhillEfficiency.

Förnuftiga värden: för förbränningsmodell: 0,27, för elektrisk modell: 0,74

uphillEfficiency?: number

Egenskapsvärde

number

vehicleAxleWeight

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

vehicleAxleWeight?: number

Egenskapsvärde

number

vehicleCommercial

Om fordonet används i kommersiellt syfte. Nyttofordon får inte köra på vissa vägar.

vehicleCommercial?: boolean

Egenskapsvärde

boolean

vehicleEngineType

Fordonets motortyp. När en detaljerad förbrukningsmodell anges måste den vara konsekvent med värdet för vehicleEngineType.

vehicleEngineType?: "combustion" | "electric"

Egenskapsvärde

"combustion" | "electric"

vehicleHeading

Fordonets riktning i grader som börjar på true North och fortsätter i medsols riktning. Norr är 0 grader, öst är 90 grader, söder är 180 grader, väst är 270 grader. Möjliga värden 0–359

vehicleHeading?: 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.

  • Det är obligatoriskt om någon av *Effektivitetsparametrarna har angetts.

  • Det måste vara strikt positivt när det används i kontexten för förbrukningsmodellen. Viktbegränsningar beaktas.

  • Om ingen detaljerad förbrukningsmodell anges och värdet för vehicleWeight inte är noll, beaktas viktbegränsningar.

  • I alla andra fall ignoreras den här parametern.

Förnuftiga värden: för förbränningsmodell: 1600, för elektrisk modell : 1900

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

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"