Dela via

Route - Get Route Range

  • Referens
Tjänst:
Maps
API-version:
1.0

Använd för att skapa en karta som visar det område som är tillgängligt från en viss punkt inom ett visst tröskelvärde baserat på tid, avstånd eller bränslekapacitet.

Get Route Range API:et (Isochrone) är en HTTP-begäran GET som beräknar en uppsättning platser som kan nås från ursprungspunkten baserat på den bränsle-, energi-, tids- eller avståndsbudget som anges. En polygongräns (eller Isochrone) returneras i en motsolsorientering samt det exakta polygoncentret som var resultatet av ursprungspunkten.

Den returnerade polygonen kan användas för ytterligare bearbetning, till exempel Sök inuti geometri för att söka efter URI:er inom den angivna isochronen.

GET https://atlas.microsoft.com/route/range/{format}?api-version=1.0&query={query}
Med valfria parametrar: 
GET https://atlas.microsoft.com/route/range/{format}?api-version=1.0&query={query}&fuelBudgetInLiters={fuelBudgetInLiters}&energyBudgetInkWh={energyBudgetInkWh}&timeBudgetInSec={timeBudgetInSec}&distanceBudgetInMeters={distanceBudgetInMeters}&departAt={departAt}&routeType={routeType}&traffic={traffic}&avoid={avoid}&travelMode={travelMode}&hilliness={hilliness}&windingness={windingness}&vehicleAxleWeight={vehicleAxleWeight}&vehicleWidth={vehicleWidth}&vehicleHeight={vehicleHeight}&vehicleLength={vehicleLength}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&vehicleCommercial={vehicleCommercial}&vehicleLoadType={vehicleLoadType}&vehicleEngineType={vehicleEngineType}&constantSpeedConsumptionInLitersPerHundredkm={constantSpeedConsumptionInLitersPerHundredkm}&currentFuelInLiters={currentFuelInLiters}&auxiliaryPowerInLitersPerHour={auxiliaryPowerInLitersPerHour}&fuelEnergyDensityInMJoulesPerLiter={fuelEnergyDensityInMJoulesPerLiter}&accelerationEfficiency={accelerationEfficiency}&decelerationEfficiency={decelerationEfficiency}&uphillEfficiency={uphillEfficiency}&downhillEfficiency={downhillEfficiency}&constantSpeedConsumptionInkWhPerHundredkm={constantSpeedConsumptionInkWhPerHundredkm}&currentChargeInkWh={currentChargeInkWh}&maxChargeInkWh={maxChargeInkWh}&auxiliaryPowerInkW={auxiliaryPowerInkW}

URI-parametrar

Name I Obligatorisk Typ Description
format
 path True

ResponseFormat

Önskat format för svaret. Värdet kan vara antingen json eller xml.
api-version
 query True

string

Versionsnummer för Azure Maps API.
query
 query True

number[]

Koordinaten som intervallberäkningen ska starta från.
accelerationEfficiency
 query

number

double

Anger effektiviteten för att omvandla kemisk energi lagrad 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 kopplas ihop med retardationEfficiency.

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

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

number

double

Anger den mängd ström som förbrukas för att upprätthålla extra system, i kilowatt (kW).

Den 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
 query

number

double

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

Den 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
 query

RouteAvoidType[]

Anger något som vägberäkningen ska försöka undvika när du fastställer 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 redanUsedRoads inte användas.
constantSpeedConsumptionInkWhPerHundredkm
 query

string

Anger den hastighetsberoende komponenten i förbrukningen.

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.

Den förbrukning som anges för den största hastigheten måste vara större än eller lika med den näst högsta 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 mindre hastighet.

Det giltiga intervallet för förbrukningsvärdena (uttryckt i kWh/100 km) ä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 modellen elektrisk förbrukning.
constantSpeedConsumptionInLitersPerHundredkm
 query

string

Anger den hastighetsberoende komponenten i förbrukningen.

Tillhandahålls som en osorterad lista över kolonavgränsade hastighet & förbrukningshastighetspar. 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.

Den förbrukning som anges för den största hastigheten måste vara större än eller lika med den näst högsta 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 mindre hastighet.

Det giltiga intervallet för förbrukningsvärdena (uttryckt i l/100 km) ä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
 query

number

double

Anger den aktuella elenergitillförseln i kilowattimmar (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
 query

number

double

Anger den aktuella tillförseln av bränsle i liter.

Förnuftiga värden: 55
decelerationEfficiency
 query

number

double

Anger effektiviteten för 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 accelerationEfficiency.

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
 query

string

date-time

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-20T00:39:57+00:00

Parametern departAt kan inte användas tillsammans med arriveAt.
distanceBudgetInMeters
 query

number

double

Avståndsbudget i mätare som avgör maximal räckvidd som kan färdas med körsträcka. Förbrukningsmodellen påverkar bara intervallet när routeType är eco.
Exakt en budget (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec eller distanceBudgetInMeters) måste användas.
downhillEfficiency
 query

number

double

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 paras ihop med uphillEfficiency.

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

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

number

double

Elenergibudget i kilowattimmar (kWh) som bestämmer maximalt intervall som kan färdas med den angivna elförbrukningsmodellen.
När energyBudgetInkWh används är det obligatoriskt att ange en detaljerad modell för elektrisk förbrukning.
Exakt en budget (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec eller distanceBudgetInMeters) måste användas.
fuelBudgetInLiters
 query

number

double

Bränslebudget i liter som bestämmer maximalt intervall som kan färdas med den angivna förbränningsförbrukningsmodellen.
När fuelBudgetInLiters används är det obligatoriskt att ange en detaljerad förbränningsförbrukningsmodell.
Exakt en budget (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec eller distanceBudgetInMeters) måste användas.
fuelEnergyDensityInMJoulesPerLiter
 query

number

double

Anger mängden kemisk energi som lagras i en liter bränsle i megajoule (MJ). Den används tillsammans med *Effektivitetsparametrarna för konverteringar mellan sparad eller förbrukad energi och bränsle. Energidensitet ä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 *Effektivitetsparameter har angetts.

Förnuftiga värden: 34.2
hilliness
 query

InclineLevel

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

number

double

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
routeType
 query

RouteType

Den typ av väg som begärs.
timeBudgetInSec
 query

number

double

Tidsbudget i sekunder som avgör maximalt intervall som kan färdas med körtid. Förbrukningsmodellen påverkar bara intervallet när routeType är eco.
Exakt en budget (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec eller distanceBudgetInMeters) måste användas.
traffic
 query

boolean

Möjliga värden:

  • true – Överväg 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
 query

TravelMode

Färdsätt för den begärda rutten. Om det inte definieras ä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 är travelMode-elementet i svaret för det avsnittet "annat". Observera att färdlägena buss, motorcykel, taxi och van är BETA-funktioner. Fullständiga begränsningsdata är inte tillgängliga i alla områden.
uphillEfficiency
 query

number

double

Anger effektiviteten för att omvandla kemisk energi lagrad 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 paras ihop med downhillEfficiency.

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

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

integer

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

boolean

Om fordonet används för kommersiella ändamål. Nyttofordon får inte köra på vissa vägar.
vehicleEngineType
 query

VehicleEngineType

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

number

double

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

number

double

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

VehicleLoadType

Typer av last som kan klassificeras som farligt material och som är begränsade från vissa vägar. Tillgängliga vehicleLoadType-värden är amerikanska Hazmat-klasser 1 till och med 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 andraHazmat 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
 query

integer

Fordonets högsta hastighet i km/timme. Maxhastigheten i fordonsprofilen används för att kontrollera om ett fordon är tillåtet 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, kommer routningsmotorn återigen att använda 60 km/timme.
vehicleWeight
 query

integer

Fordonets vikt i kg.

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

  • Den måste vara strikt positiv när den används i kontexten för förbrukningsmodellen. Viktbegränsningar beaktas.

  • Om ingen detaljerad förbrukningsmodell anges och värdet för vehicleWeight är icke-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
 query

number

double

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

WindingnessLevel

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

Begärandehuvud

Name Obligatorisk Typ Description
x-ms-client-id

string

Anger vilket konto som är avsett för användning tillsammans med Microsoft Entra ID-säkerhetsmodellen. Den representerar ett unikt ID för Azure Maps-kontot och kan hämtas från Konto-API:et för Azure Maps-hanteringsplan. Information om hur du använder Microsoft Entra ID-säkerhet i Azure Maps finns i följande artiklar .

Svar

Name Typ Description
200 OK

RouteRangeResult

OK
Other Status Codes

ErrorResponse

Det uppstod ett oväntat fel.

Säkerhet

AADToken

Det här är Microsoft Entra OAuth 2.0-flöden . När den är kopplad till rollbaserad åtkomstkontroll i Azure kan den användas för att styra åtkomsten till REST-API:er för Azure Maps. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till ett eller flera Azure Maps-resurskonton eller underresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter till Rest-API:er för Azure Maps.

För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan ha åtkomstkontroll för specifika API:er och omfång.

Kommentarer

  • Den här säkerhetsdefinitionen x-ms-client-idkräver att huvudet används för att ange vilken Azure Maps-resurs programmet begär åtkomst till. Detta kan hämtas från MAPS-hanterings-API:et.

Authorization URL är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra-ID-konfigurationer. * Rollbaserad åtkomstkontroll i Azure konfigureras från Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er. * Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Det här är en delad nyckel som etableras när du skapar ett Azure Maps-konto i Azure-portalen eller använder PowerShell, CLI, Azure SDK:er eller REST API.

Med den här nyckeln kan alla program komma åt alla REST-API:et. Med andra ord kan den här nyckeln användas som huvudnyckel i det konto som de har utfärdats i.

För offentligt exponerade program rekommenderar vi att du använder metoden för konfidentiella klientprogram för att få åtkomst till REST-API:er för Azure Maps så att din nyckel kan lagras på ett säkert sätt.

Typ: apiKey
I: query

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från åtgärden List SAS på Azure Maps-resursen via Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.

Med den här token har alla program behörighet att komma åt med rollbaserade Åtkomstkontroller i Azure och detaljerad kontroll av förfallodatum, frekvens och region för användning för den specifika token. Med andra ord kan SAS-token användas för att tillåta program att styra åtkomsten på ett säkrare sätt än den delade nyckeln.

För offentligt exponerade program rekommenderar vi att du konfigurerar en specifik lista över tillåtna ursprung på map-kontoresursen för att begränsa återgivningsmissbruket och regelbundet förnya SAS-token.

Typ: apiKey
I: header

Exempel

Successfully retrieve a set of locations that can be reached from the origin point based on various conditions

Exempelbegäran

GET https://atlas.microsoft.com/route/range/json?api-version=1.0&query=50.97452,5.86605&timeBudgetInSec=6000

Exempelsvar

Statuskod:
200 
{
  "formatVersion": "0.0.1",
  "reachableRange": {
    "center": {
      "latitude": 50.9745,
      "longitude": 5.86605
    },
    "boundary": [
      {
        "latitude": 52.03704,
        "longitude": 5.73602
      },
      {
        "latitude": 52.09456,
        "longitude": 5.59435
      },
      {
        "latitude": 52.16815,
        "longitude": 5.42279
      },
      {
        "latitude": 52.25047,
        "longitude": 5.21276
      },
      {
        "latitude": 52.21374,
        "longitude": 5.15355
      },
      {
        "latitude": 52.25674,
        "longitude": 4.96687
      },
      {
        "latitude": 52.07834,
        "longitude": 4.739
      },
      {
        "latitude": 52.05647,
        "longitude": 4.72513
      },
      {
        "latitude": 51.94553,
        "longitude": 4.53237
      },
      {
        "latitude": 51.70119,
        "longitude": 4.31165
      },
      {
        "latitude": 51.5837,
        "longitude": 4.28917
      },
      {
        "latitude": 51.48463,
        "longitude": 3.82685
      },
      {
        "latitude": 51.21096,
        "longitude": 3.62838
      },
      {
        "latitude": 50.6814,
        "longitude": 3.89244
      },
      {
        "latitude": 50.66791,
        "longitude": 3.93493
      },
      {
        "latitude": 50.49042,
        "longitude": 3.98156
      },
      {
        "latitude": 50.30944,
        "longitude": 4.47995
      },
      {
        "latitude": 50.24448,
        "longitude": 4.60502
      },
      {
        "latitude": 50.24467,
        "longitude": 4.89999
      },
      {
        "latitude": 50.08735,
        "longitude": 5.04206
      },
      {
        "latitude": 49.99214,
        "longitude": 5.23042
      },
      {
        "latitude": 49.88478,
        "longitude": 5.40994
      },
      {
        "latitude": 49.85797,
        "longitude": 5.46178
      },
      {
        "latitude": 49.86279,
        "longitude": 5.7196
      },
      {
        "latitude": 49.83259,
        "longitude": 5.74151
      },
      {
        "latitude": 50.22239,
        "longitude": 5.9387
      },
      {
        "latitude": 50.0011,
        "longitude": 6.08535
      },
      {
        "latitude": 50.04616,
        "longitude": 6.12089
      },
      {
        "latitude": 50.09472,
        "longitude": 6.28373
      },
      {
        "latitude": 49.95863,
        "longitude": 6.51654
      },
      {
        "latitude": 50.00485,
        "longitude": 6.61034
      },
      {
        "latitude": 50.00587,
        "longitude": 6.70295
      },
      {
        "latitude": 50.2947,
        "longitude": 6.65865
      },
      {
        "latitude": 50.36903,
        "longitude": 6.79276
      },
      {
        "latitude": 50.31614,
        "longitude": 7.32163
      },
      {
        "latitude": 50.36737,
        "longitude": 7.58782
      },
      {
        "latitude": 50.46919,
        "longitude": 7.7626
      },
      {
        "latitude": 50.96246,
        "longitude": 7.9826
      },
      {
        "latitude": 51.07086,
        "longitude": 7.55924
      },
      {
        "latitude": 51.36614,
        "longitude": 7.58138
      },
      {
        "latitude": 51.52015,
        "longitude": 7.67861
      },
      {
        "latitude": 51.65781,
        "longitude": 7.35175
      },
      {
        "latitude": 51.81916,
        "longitude": 7.21664
      },
      {
        "latitude": 51.9587,
        "longitude": 7.0467
      },
      {
        "latitude": 51.82713,
        "longitude": 6.67267
      },
      {
        "latitude": 51.81133,
        "longitude": 6.48424
      },
      {
        "latitude": 51.9368,
        "longitude": 6.27316
      },
      {
        "latitude": 52.01701,
        "longitude": 6.14452
      },
      {
        "latitude": 52.20847,
        "longitude": 6.09312
      },
      {
        "latitude": 52.23705,
        "longitude": 6.01297
      }
    ]
  }
}

Definitioner

Name Description
EffectiveSetting

Effektiv parameter eller data som används vid anrop av det här routnings-API:et.
ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.
ErrorDetail

Felinformationen.
ErrorResponse

Felsvar
InclineLevel

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

En plats som representeras som latitud och longitud.
ResponseFormat

Önskat format för svaret. Värdet kan vara antingen json eller xml.
RouteAvoidType

Anger något som vägberäkningen bör försöka undvika när du fastställer 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.
RouteRange

Räckviddsbart område
RouteRangeResult

Det här objektet returneras från ett lyckat routningsanrop för räckviddsintervall
RouteReport

Rapporterar de gällande inställningarna som används i det aktuella anropet.
RouteType

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

Färdmedel för den begärda rutten. Om det inte definieras är standardvärdet "car". Observera att den begärda travelMode kanske inte är tillgänglig för hela rutten. 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 reslägen buss, motorcykel, taxi och van är BETA-funktioner. Fullständiga begränsningsdata är inte tillgängliga i alla områden.
VehicleEngineType

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

Typer av last som kan klassificeras som farliga material och begränsas från vissa vägar. Tillgängliga vehicleLoadType-värden är AMERIKANSKA Hazmat-klasser 1 till och med 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 andraHazmat 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.
WindingnessLevel

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

EffectiveSetting

Effektiv parameter eller data som används vid anrop av det här routnings-API:et.

Name Typ Description
key

string

Namnet på parametern som används.
value

string

Värdet för den parameter som används.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Den ytterligare informationen.
type

string

Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.
code

string

Felkoden.
details

ErrorDetail[]

Felinformationen.
message

string

Felmeddelandet.
target

string

Felmålet.

ErrorResponse

Felsvar

Name Typ Description
error

ErrorDetail

Felobjektet.

InclineLevel

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

Name Typ Description
high

string

hög
low

string

låg
normal

string

normal

LatLongPair

En plats som representeras som latitud och longitud.

Name Typ Description
latitude

number

Latitude-egenskap
longitude

number

Longitudegenskap

ResponseFormat

Önskat format för svaret. Värdet kan vara antingen json eller xml.

Name Typ Description
json

string

Datautbytesformat för JavaScript-objektnotation
xml

string

Utökningsbart markeringsspråk

RouteAvoidType

Anger något som vägberäkningen bör försöka undvika när du fastställer 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.

Name Typ Description
alreadyUsedRoads

string

Undviker att använda samma väg flera gånger. Mest användbart tillsammans med routeType=spännande.
borderCrossings

string

Undviker gränsövergångar i vägberäkningen.
carpools

string

Undviker vägar som kräver användning av samåkningsbanor (HOV/High Occupancy Vehicle).
ferries

string

Undviker färjor
motorways

string

Undviker motorvägar
tollRoads

string

Undviker avgiftsbelagda vägar.
unpavedRoads

string

Undviker osparade vägar

RouteRange

Räckviddsbart område

Name Typ Description
boundary

LatLongPair[]

Polygongränsen för det nåbara intervallet som representeras som en lista med punkter.
center

LatLongPair

Mittpunkt för det nåbara intervallet

RouteRangeResult

Det här objektet returneras från ett lyckat routningsanrop för räckviddsintervall

Name Typ Description
formatVersion

string

Formatversionsegenskap
reachableRange

RouteRange

Räckviddsbart område
report

RouteReport

Rapporterar de gällande inställningarna som används i det aktuella anropet.

RouteReport

Rapporterar de gällande inställningarna som används i det aktuella anropet.

Name Typ Description
effectiveSettings

EffectiveSetting[]

Effektiva parametrar eller data som används vid anrop av det här routnings-API:et.

RouteType

Den typ av väg som begärs.

Name Typ Description
eco

string

En väg balanserad av ekonomi och hastighet.
fastest

string

Den snabbaste rutten.
shortest

string

Den kortaste rutten med avstånd.
thrilling

string

Innehåller intressanta eller utmanande vägar och använder så få motorvägar som möjligt. Du kan välja vilken nivå av svängar som ingår och även graden av bergighet. Se parametrarna för hilliness och windingness för hur du ställer in detta. Det finns en gräns på 900 km på rutter planerade med routeType= spännande

TravelMode

Färdmedel för den begärda rutten. Om det inte definieras är standardvärdet "car". Observera att den begärda travelMode kanske inte är tillgänglig för hela rutten. 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 reslägen buss, motorcykel, taxi och van är BETA-funktioner. Fullständiga begränsningsdata är inte tillgängliga i alla områden.

Name Typ Description
bus

string

De returnerade vägarna är optimerade för bussar, inklusive användning av endast bussfiler. BETA-funktioner.
car

string

De returnerade vägarna är optimerade för bilar.
motorcycle

string

De returnerade vägarna är optimerade för motorcyklar. BETA-funktioner.
taxi

string

De returnerade vägarna är optimerade för taxibilar. BETA-funktioner.
truck

string

De returnerade vägarna är optimerade för nyttofordon, till exempel för lastbilar.
van

string

De returnerade vägarna är optimerade för skåpbilar. BETA-funktioner.

VehicleEngineType

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

Name Typ Description
combustion

string

Förbränningsmotor.
electric

string

Elmotor.

VehicleLoadType

Typer av last som kan klassificeras som farliga material och begränsas från vissa vägar. Tillgängliga vehicleLoadType-värden är AMERIKANSKA Hazmat-klasser 1 till och med 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 andraHazmat 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.

Name Typ Description
USHazmatClass1

string

Explosiva ämnen och föremål
USHazmatClass2

string

Komprimerad gas
USHazmatClass3

string

Brandfarliga vätskor
USHazmatClass4

string

Brandfarliga fasta ämnen
USHazmatClass5

string

Oxidatorer
USHazmatClass6

string

Gifter
USHazmatClass7

string

Radioaktiva ämnen
USHazmatClass8

string

Frätande
USHazmatClass9

string

Övriga farliga ämnen
otherHazmatExplosive

string

Explosiva ämnen och föremål
otherHazmatGeneral

string

Övriga farliga ämnen
otherHazmatHarmfulToWater

string

Skadligt för vatten

WindingnessLevel

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

Name Typ Description
high

string

hög
low

string

låg
normal

string

normal