Dela via


Route - Get Route Directions

Använd för att beräkna en väg mellan ett angivet ursprung och ett mål som passerar genom angivna waypoints.

Get Route Directions-API:et är en HTTP-GET begäran som returnerar en väg mellan ett ursprung och ett mål som passerar genom vägpunkter om det anges. Rutten tar hänsyn till faktorer som aktuell trafik och de typiska väghastigheterna på den begärda veckodagen och tiden på dagen.

Informationen som returneras omfattar avståndet, den uppskattade restiden och en representation av routningsgeometrin. Ytterligare routningsinformation, till exempel optimerad waypoint-ordning eller tur-för-tur-instruktioner, är också tillgänglig, beroende på vilka alternativ som valts.

Routningstjänsten tillhandahåller en uppsättning parametrar för en detaljerad beskrivning av en fordonsspecifik förbrukningsmodell. Mer information finns i förbrukningsmodell.

GET https://atlas.microsoft.com/route/directions/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/route/directions/{format}?api-version=1.0&query={query}&maxAlternatives={maxAlternatives}&alternativeType={alternativeType}&minDeviationDistance={minDeviationDistance}&arriveAt={arriveAt}&departAt={departAt}&minDeviationTime={minDeviationTime}&instructionsType={instructionsType}&language={language}&computeBestOrder={computeBestOrder}&routeRepresentation={routeRepresentation}&computeTravelTimeFor={computeTravelTimeFor}&vehicleHeading={vehicleHeading}&report=effectiveSettings&sectionType={sectionType}&vehicleAxleWeight={vehicleAxleWeight}&vehicleWidth={vehicleWidth}&vehicleHeight={vehicleHeight}&vehicleLength={vehicleLength}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&vehicleCommercial={vehicleCommercial}&windingness={windingness}&hilliness={hilliness}&travelMode={travelMode}&avoid={avoid}&traffic={traffic}&routeType={routeType}&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

string

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.

accelerationEfficiency
query

number

double

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
query

AlternativeRouteType

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

arriveAt
query

string

date-time

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
query

number

double

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
query

number

double

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
query

RouteAvoidType[]

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
query

boolean

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
query

ComputeTravelTime

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
query

string

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
query

string

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
query

number

double

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
query

number

double

Anger den aktuella bränsletillförseln i liter.

Förnuftiga värden: 55

decelerationEfficiency
query

number

double

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
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-19T16:39:57-08:00

Parametern departAt kan inte användas tillsammans med arriveAt.

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

number

double

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
query

InclineLevel

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

instructionsType
query

RouteInstructionsType

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

language
query

string

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
query

integer

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

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

minDeviationDistance
query

integer

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
query

integer

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.
report
query

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
query

RouteRepresentationForBestOrder

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

routeType
query

RouteType

Den typ av väg som begärs.

sectionType
query

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
query

boolean

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
query

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
query

number

double

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
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 i kommersiellt syfte. 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.

vehicleHeading
query

integer

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

integer

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
query

integer

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
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. Det 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 för vägledning.

Svar

Name Typ Description
200 OK

RouteDirections

OKEJ

Other Status Codes

ErrorResponse

Ett oväntat fel uppstod.

Säkerhet

AADToken

Det här är Microsoft Entra OAuth 2.0 Flows. När du parkopplas med rollbaserad åtkomst i Azure kontroll kan den användas för att styra åtkomsten till Azure Maps REST-API:er. 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 Azure Maps REST-API:er.

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 få åtkomstkontroll för specifika API:er och omfång.

Anteckningar

  • Den här säkerhetsdefinitionen kräver användningen av x-ms-client-id-huvudet 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 specifik för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra-ID-konfigurationer. * Den rollbaserade åtkomstkontrollen i Azure konfigureras från Azure-hanteringsplan 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 Skapa ett Azure Maps-konto i Azure-portalen eller med hjälp av PowerShell, CLI, Azure SDK:er eller REST API.

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

För offentligt exponerade program rekommenderar vi att du använder konfidentiella klientprogram metod för åtkomst till Azure Maps REST-API:er 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 sas-åtgärden Lista 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 till 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 mer säkert 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 route between an origin and a destination

Exempelbegäran

GET https://atlas.microsoft.com/route/directions/json?api-version=1.0&query=52.50931,13.42936:52.50274,13.43872&report=effectiveSettings

Exempelsvar

{
  "formatVersion": "0.0.12",
  "routes": [
    {
      "summary": {
        "lengthInMeters": 1147,
        "travelTimeInSeconds": 162,
        "trafficDelayInSeconds": 0,
        "departureTime": "2017-09-07T16:56:58+00:00",
        "arrivalTime": "2017-09-07T16:59:40+00:00"
      },
      "legs": [
        {
          "summary": {
            "lengthInMeters": 1147,
            "travelTimeInSeconds": 162,
            "trafficDelayInSeconds": 0,
            "departureTime": "2017-09-07T16:56:58+00:00",
            "arrivalTime": "2017-09-07T16:59:40+00:00"
          },
          "points": [
            {
              "latitude": 52.50931,
              "longitude": 13.42937
            },
            {
              "latitude": 52.50904,
              "longitude": 13.42912
            },
            {
              "latitude": 52.50894,
              "longitude": 13.42904
            },
            {
              "latitude": 52.50867,
              "longitude": 13.42879
            },
            {
              "latitude": 52.5084,
              "longitude": 13.42857
            },
            {
              "latitude": 52.50791,
              "longitude": 13.42824
            },
            {
              "latitude": 52.50757,
              "longitude": 13.42772
            },
            {
              "latitude": 52.50735,
              "longitude": 13.42823
            },
            {
              "latitude": 52.5073,
              "longitude": 13.42836
            },
            {
              "latitude": 52.50573,
              "longitude": 13.43194
            },
            {
              "latitude": 52.50512,
              "longitude": 13.43336
            },
            {
              "latitude": 52.50464,
              "longitude": 13.43451
            },
            {
              "latitude": 52.5045,
              "longitude": 13.43481
            },
            {
              "latitude": 52.50443,
              "longitude": 13.43498
            },
            {
              "latitude": 52.50343,
              "longitude": 13.43737
            },
            {
              "latitude": 52.50274,
              "longitude": 13.43872
            }
          ]
        }
      ],
      "sections": [
        {
          "startPointIndex": 0,
          "endPointIndex": 15,
          "sectionType": "TRAVEL_MODE",
          "travelMode": "car"
        }
      ]
    }
  ]
}

Definitioner

Name Description
AlternativeRouteType

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

ComputeTravelTime

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

DelayMagnitude

Omfattningen av fördröjningen som orsakas av incidenten. Dessa värden motsvarar värdena i svarsfältet ty för api:et Hämta information om trafikincidenter.

DrivingSide

Anger vänster eller höger sida körning vid tidpunkten för manövern.

EffectiveSetting

Effektiv parameter eller data som används när du anropar det här routnings-API:et.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorDetail

Felinformationen.

ErrorResponse

Felsvar

GuidanceInstructionType

Typ av instruktion, t.ex. sväng eller ändring av vägform.

GuidanceManeuver

En kod som identifierar manövern.

InclineLevel

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

JunctionType

Typ av korsning där manövern äger rum. För större rondeller genereras två separata instruktioner för att komma in och lämna rondellen.

LatLongPair

En plats som representeras som latitud och longitud.

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.

ResponseFormat

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

ResponseSectionType

Avsnittstyper för det rapporterade vägsvaret

ResponseTravelMode

Reseläge för den beräknade vägen. Värdet anges till other om det begärda transportsättet inte är möjligt i det här avsnittet

Route
RouteAvoidType

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.

RouteDirections

Det här objektet returneras från ett lyckat Vägbeskrivningsanrop

RouteGuidance

Innehåller vägledningsrelaterade element. Det här fältet finns bara när vägledning begärdes och är tillgängligt.

RouteInstruction

En uppsättning attribut som beskriver en manöver, t.ex. "Sväng höger", "Håll vänster", "Ta färjan", "Ta motorvägen", "Anländer".

RouteInstructionGroup

Grupperar en sekvens med instruktionselement som är relaterade till varandra. Sekvensintervallet är begränsat med firstInstructionIndex och lastInstructionIndex. När textmeddelanden som kan läsas av människor begärs för vägledning (instructionType=text eller taggade) har instruktionsgruppen ett sammanfattningsmeddelande som returneras när det är tillgängligt.

RouteInstructionsType

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

RouteLeg

En beskrivning av en del av en väg, som består av en lista över punkter. Varje ytterligare vägpunkt som anges i begäran resulterar i ytterligare ett ben i den returnerade vägen.

RouteLegSummary

Sammanfattningsobjekt för vägavsnittet.

RouteOptimizedWaypoint

Optimerat vägpunktsobjekt.

RouteReport

Rapporterar de effektiva inställningar som används i det aktuella anropet.

RouteRepresentationForBestOrder

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

RouteSection

Vägavsnitt innehåller ytterligare information om delar av en väg. Varje avsnitt innehåller minst elementen startPointIndex, endPointIndexoch sectionType.

RouteSectionTec

Information om trafikhändelsen med hjälp av definitioner i TPEG2-TEC- standard. Kan innehålla effectCode och orsakar element.

RouteSectionTecCause

Orsaken till trafikhändelsen. Kan innehålla mainCauseCode- och subCauseCode-element. Kan användas för att definiera ikonografi och beskrivningar.

RouteSummary

Sammanfattningsobjekt

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

SimpleCategory

Typ av incident. Kan för närvarande vara JAM, ROAD_WORK, ROAD_CLOSURE eller OTHER. Mer information finns i "tec".

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.

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

WindingnessLevel

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

AlternativeRouteType

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

Name Typ Description
anyRoute

string

Tillåt att en alternativ väg returneras oavsett hur den jämförs med referensvägen när det gäller optimalitet.

betterRoute

string

Returnera endast en alternativ väg om den är bättre än referensvägen enligt de angivna planeringskriterierna.

ComputeTravelTime

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

Name Typ Description
all

string

Beräknar restider för alla typer av trafikinformation och anger alla resultat i fälten noTrafficTravelTimeInSeconds, historicTrafficTravelTimeInSeconds och liveTrafficIncidentsTravelTimeInSeconds som ingår i sammanfattningarna i vägsvaret.

none

string

Beräknar inte ytterligare restider.

DelayMagnitude

Omfattningen av fördröjningen som orsakas av incidenten. Dessa värden motsvarar värdena i svarsfältet ty för api:et Hämta information om trafikincidenter.

Name Typ Description
0

string

Okänd.

1

string

Underårig.

2

string

Moderat.

3

string

Major.

4

string

Odefinierad, används för vägavstängningar och andra obestämda förseningar.

DrivingSide

Anger vänster eller höger sida körning vid tidpunkten för manövern.

Name Typ Description
LEFT

string

Vänster.

RIGHT

string

Höger sida.

EffectiveSetting

Effektiv parameter eller data som används när du anropar det här routnings-API:et.

Name Typ Description
key

string

Namnet på den parameter som används.

value

string

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

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Ytterligare information.

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.

GuidanceInstructionType

Typ av instruktion, t.ex. sväng eller ändring av vägform.

Name Typ Description
DIRECTION_INFO

string

Riktningsinformation.

LOCATION_ARRIVAL

string

Ankomstplats.

LOCATION_DEPARTURE

string

Avgångsplats.

LOCATION_WAYPOINT

string

Plats för vägpunkt.

ROAD_CHANGE

string

Vägändring.

TURN

string

Vända.

GuidanceManeuver

En kod som identifierar manövern.

Name Typ Description
ARRIVE

string

Du har kommit.

ARRIVE_LEFT

string

Du har kommit. Målet är till vänster.

ARRIVE_RIGHT

string

Du har kommit. Målet är till höger.

BEAR_LEFT

string

Björn till vänster.

BEAR_RIGHT

string

Ha rätt.

DEPART

string

Lämna.

ENTER_FREEWAY

string

Ta motorvägen.

ENTER_HIGHWAY

string

Ta motorvägen.

ENTER_MOTORWAY

string

Ta motorvägen.

ENTRANCE_RAMP

string

Ta rampen.

FOLLOW

string

Följa.

KEEP_LEFT

string

Behåll vänster.

KEEP_RIGHT

string

Håll dig till höger.

MAKE_UTURN

string

Gör en U-sväng.

MOTORWAY_EXIT_LEFT

string

Ta vänster utgång.

MOTORWAY_EXIT_RIGHT

string

Ta höger utgång.

ROUNDABOUT_BACK

string

Gå runt i rondellen.

ROUNDABOUT_CROSS

string

Korsa rondellen.

ROUNDABOUT_LEFT

string

Vid rondellen tar du avfarten till vänster.

ROUNDABOUT_RIGHT

string

Vid rondellen tar du avfarten till höger.

SHARP_LEFT

string

Sväng skarp vänster.

SHARP_RIGHT

string

Sväng skarp höger.

STRAIGHT

string

Håll dig rakt på.

SWITCH_MAIN_ROAD

string

Byt till huvudvägen.

SWITCH_PARALLEL_ROAD

string

Växla till den parallella vägen.

TAKE_EXIT

string

Ta avslutet.

TAKE_FERRY

string

Ta färjan.

TRY_MAKE_UTURN

string

Försök att göra en U-sväng.

TURN_LEFT

string

Sväng vänster.

TURN_RIGHT

string

Sväng höger.

WAYPOINT_LEFT

string

Du har nått vägpunkten. Det är till vänster.

WAYPOINT_REACHED

string

Du har nått vägpunkten.

WAYPOINT_RIGHT

string

Du har nått vägpunkten. Det är till höger.

InclineLevel

Grad av bergighet för spännande väg. 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

JunctionType

Typ av korsning där manövern äger rum. För större rondeller genereras två separata instruktioner för att komma in och lämna rondellen.

Name Typ Description
BIFURCATION

string

bifurkation

REGULAR

string

ordinarie

ROUNDABOUT

string

rondell

LatLongPair

En plats som representeras som latitud och longitud.

Name Typ Description
latitude

number

Latitude-egenskap

longitude

number

Longitudegenskap

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.

Name Typ Description
effectiveSettings

string

Rapporterar de effektiva parametrar eller data som används vid anrop till API:et.

ResponseFormat

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

Name Typ Description
json

string

JavaScript-objekt notationens datautbytesformat

xml

string

Det utökningsbara markupspråket

ResponseSectionType

Avsnittstyper för det rapporterade vägsvaret

Name Typ Description
CARPOOL

string

Delar av den väg som kräver användning av samåkningsbanor (HOV/High Occupancy Vehicle).

CAR_TRAIN

string

Delar av rutten som är bilar eller tåg.

COUNTRY

string

Avsnitt som anger vilka länder/regioner vägen finns i.

FERRY

string

Delar av rutten som är färjor.

MOTORWAY

string

Delar av rutten som är motorvägar.

PEDESTRIAN

string

Delar av rutten som endast är lämpliga för fotgängare.

TOLL_ROAD

string

Delar av vägen som kräver att en avgift betalas.

TOLL_VIGNETTE

string

Delar av vägen som kräver att en avgiftsbelagd vinjett finns.

TRAFFIC

string

Delar av vägen som innehåller trafikinformation.

TRAVEL_MODE

string

Avsnitt i förhållande till parametern request travelMode.

TUNNEL

string

Delar av vägen som är tunnlar.

URBAN

string

Delar av rutten som finns i stadsområden.

ResponseTravelMode

Reseläge för den beräknade vägen. Värdet anges till other om det begärda transportsättet inte är möjligt i det här avsnittet

Name Typ Description
bicycle

string

De returnerade vägarna är optimerade för cyklar, inklusive användning av cykelbanor.

bus

string

De returnerade rutterna ä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.

other

string

Det angivna transportsättet är inte möjligt i det här avsnittet

pedestrian

string

De returnerade vägarna är optimerade för fotgängare, inklusive användning av trottoarer.

taxi

string

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

truck

string

De returnerade rutterna är optimerade för nyttofordon, till exempel för lastbilar.

van

string

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

Route

Name Typ Description
guidance

RouteGuidance

Innehåller vägledningsrelaterade element. Det här fältet finns bara när vägledning begärdes och är tillgängligt.

legs

RouteLeg[]

Benmatris

sections

RouteSection[]

Matris för avsnitt

summary

RouteSummary

Sammanfattningsobjekt

RouteAvoidType

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.

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 bilpooler (HOV/High Occupancy Vehicle) körfält.

ferries

string

Undviker färjor

motorways

string

Undviker motorvägar

tollRoads

string

Undviker avgiftsbelagda vägar.

unpavedRoads

string

Undviker osparade vägar

RouteDirections

Det här objektet returneras från ett lyckat Vägbeskrivningsanrop

Name Typ Description
formatVersion

string

Formatversionsegenskap

optimizedWaypoints

RouteOptimizedWaypoint[]

Optimerad sekvens av waypoints. Den visar indexet från den användardefinierade waypoint-sekvensen för den ursprungliga och optimerade listan. Till exempel ett svar:

<optimizedWaypoints>
<waypoint providedIndex="0" optimizedIndex="1"/>
<waypoint providedIndex="1" optimizedIndex="2"/>
<waypoint providedIndex="2" optimizedIndex="0"/>
</optimizedWaypoints>

innebär att den ursprungliga sekvensen är [0, 1, 2] och optimerad sekvens är [1, 2, 0]. Eftersom indexet börjar med 0 är originalet "första, andra, tredje" medan den optimerade är "second, third, first".

report

RouteReport

Rapporterar de effektiva inställningar som används i det aktuella anropet.

routes

Route[]

Routningsmatris

RouteGuidance

Innehåller vägledningsrelaterade element. Det här fältet finns bara när vägledning begärdes och är tillgängligt.

Name Typ Description
instructionGroups

RouteInstructionGroup[]

Grupperar en sekvens med instruktionselement som är relaterade till varandra.

instructions

RouteInstruction[]

En lista med instruktioner som beskriver manövrar.

RouteInstruction

En uppsättning attribut som beskriver en manöver, t.ex. "Sväng höger", "Håll vänster", "Ta färjan", "Ta motorvägen", "Anländer".

Name Typ Description
combinedMessage

string

Ett mänskligt läsbart meddelande för manövern kombinerat med meddelandet från nästa instruktion. Ibland är det möjligt att kombinera två efterföljande instruktioner i en enda instruktion som gör det lättare att följa. När så är fallet är flaggan possibleCombineWithNext sann. Till exempel:

10. Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam
11. Follow Einsteinweg/A10/E22 towards Ring Amsterdam

Flaggan possibleCombineWithNext på instruktion 10 är sann. Detta indikerar för klienterna i kodad vägledning att den kan kombineras med instruktion 11. Anvisningarna kombineras automatiskt för klienter som begär läsbar vägledning för människor. Fältet combinedMessage innehåller det kombinerade meddelandet:

Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam
then follow Einsteinweg/A10/E22 towards Ring Amsterdam.
countryCode

string

3 tecken ISO 3166-1 alfa-3 landskod. T.ex. USA.

drivingSide

DrivingSide

Anger vänster eller höger sida körning vid tidpunkten för manövern.

exitNumber

string

Antal av en motorvägsavfart som tagits av den aktuella manövern. Om en utgång har flera slutnummer avgränsas de med "" och eventuellt aggregeras med "-", t.ex. "10, 13-15".

instructionType

GuidanceInstructionType

Typ av instruktion, t.ex. sväng eller ändring av vägform.

junctionType

JunctionType

Typ av korsning där manövern äger rum. För större rondeller genereras två separata instruktioner för att komma in och lämna rondellen.

maneuver

GuidanceManeuver

En kod som identifierar manövern.

message

string

Ett mänskligt läsbart meddelande för manövern.

point

LatLongPair

En plats som representeras som latitud och longitud.

pointIndex

integer

Indexet för punkten i listan över polyline"-punkter som motsvarar instruktionens punkt.

possibleCombineWithNext

boolean

Du kan också kombinera instruktionen med nästa. Detta kan användas för att skapa meddelanden som "Sväng vänster och sedan höger".

roadNumbers

string[]

Vägnummer för nästa betydande vägsegment efter manövern eller av de vägar som ska följas. Exempel: ["E34", "N205"]

roundaboutExitNumber

integer

Detta anger vilken utgång som ska köras i en rondell.

routeOffsetInMeters

integer

Avstånd från början av vägen till instruktionens punkt.

signpostText

string

Texten på en skylt som är mest relevant för manövern, eller till den riktning som ska följas.

stateCode

string

En underindelning (t.ex. delstat) i landet, som representeras av den andra delen av en ISO 3166-2 kod. Detta är endast tillgängligt för vissa länder/regioner som USA, Kanada och Mexiko.

street

string

Gatunamn för nästa betydande vägsegment efter manövern, eller på gatan som ska följas.

travelTimeInSeconds

integer

Uppskattad restid upp till den punkt som motsvarar routeOffsetInMeters.

turnAngleInDecimalDegrees

integer

Anger instruktionens riktning. Om junctionType anger en svänginstruktion:

  • 180 = U-sväng
  • [-179, -1] = Vänstersväng
  • 0 = Rakt på (en "0 graders" sväng)
  • [1, 179] = Högersväng

Om junctionType anger en bifurcation-instruktion:

  • <0 - behåll vänster
  • >0 – håll dig rätt

RouteInstructionGroup

Grupperar en sekvens med instruktionselement som är relaterade till varandra. Sekvensintervallet är begränsat med firstInstructionIndex och lastInstructionIndex. När textmeddelanden som kan läsas av människor begärs för vägledning (instructionType=text eller taggade) har instruktionsgruppen ett sammanfattningsmeddelande som returneras när det är tillgängligt.

Name Typ Description
firstInstructionIndex

integer

Index för den första instruktionen i anvisningarna och tillhör den här gruppen.

groupLengthInMeters

integer

Gruppens längd.

groupMessage

string

Sammanfattningsmeddelande när mänskligt läsbara textmeddelanden begärs för vägledning (instructionType=text eller taggad).

lastInstructionIndex

integer

Index för den sista instruktionen i anvisningarna och tillhör den här gruppen.

RouteInstructionsType

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

Name Typ Description
coded

string

Returnerar rådata utan läsbara meddelanden.

tagged

string

Returnerar rådata med taggade meddelanden som kan läsas av människor för att tillåta formatering. Ett meddelande som kan läsas av människor bygger upp från repeterbara identifierade element. Dessa är taggade så att klientprogram kan formatera dem korrekt. Följande meddelandekomponenter taggas när instructionsType=tagged: street, roadNumber, signpostText, exitNumber, roundaboutExitNumber.

Exempel på taggat "Sväng vänster"-meddelande:

Turn left onto <roadNumber>A4</roadNumber>/<roadNumber>E19</roadNumber>
towards <signpostText>Den Haag</signpostText>
text

string

Returnerar rådata med läsbara meddelanden i oformaterad text.

RouteLeg

En beskrivning av en del av en väg, som består av en lista över punkter. Varje ytterligare vägpunkt som anges i begäran resulterar i ytterligare ett ben i den returnerade vägen.

Name Typ Description
points

LatLongPair[]

Punktmatris

summary

RouteLegSummary

Sammanfattningsobjekt för vägavsnittet.

RouteLegSummary

Sammanfattningsobjekt för vägavsnittet.

Name Typ Description
arrivalTime

string

Beräknad ankomsttid för rutten eller benet. Tiden är i UTC.

batteryConsumptionInkWh

number

Uppskattad elenergiförbrukning i kilowatttimmar (kWh) med hjälp av modellen för elektrisk förbrukning. Ingår om vehicleEngineType är inställt på elektrisk och constantSpeedConsumptionInkWhPerHundredkm anges. Värdet för batteriConsumptionInkWh inkluderar den återhämtningsbara elenergin och kan därför vara negativ (vilket indikerar att man får energi). Om både maxChargeInkWh och currentChargeInkWh anges begränsas återställningen för att säkerställa att batteriladdningsnivån aldrig överskrider maxChargeInkWh. Om varken maxChargeInkWh eller currentChargeInkWh anges antas obegränsad återhämtning i förbrukningsberäkningen.

departureTime

string

Den beräknade avgångstiden för rutten eller benet. Tiden är i UTC.

fuelConsumptionInLiters

number

Uppskattad bränsleförbrukning i liter med hjälp av förbränningsförbrukningsmodellen. Ingår om vehicleEngineType är inställt på förbränning och constantSpeedConsumptionInLitersPerHundredkm anges. Värdet blir icke-negativt.

historicTrafficTravelTimeInSeconds

integer

Beräknad restid beräknad med tidsberoende historiska trafikdata. Ingår endast om computeTravelTimeFor = alla används i frågan.

lengthInMeters

integer

Egenskapen Längd i meter

liveTrafficIncidentsTravelTimeInSeconds

integer

Beräknad restid beräknad med hjälp av realtidshastighetsdata. Ingår endast om computeTravelTimeFor = alla används i frågan.

noTrafficTravelTimeInSeconds

integer

Beräknad restid beräknad som om det inte finns några förseningar på rutten på grund av trafikförhållanden (t.ex. trafikstockningar). Ingår endast om computeTravelTimeFor = alla används i frågan.

trafficDelayInSeconds

integer

Uppskattad fördröjning i sekunder som orsakas av realtidsincidenter enligt trafikinformation. För rutter som planeras med avgångstid i framtiden är förseningar alltid 0. Om du vill returnera ytterligare restider med hjälp av olika typer av trafikinformation måste parameterberäkningTravelTimeFor=alla läggas till.

travelTimeInSeconds

integer

Uppskattad restid i sekundegenskap som inkluderar fördröjningen på grund av realtidstrafik. Observera att även när traffic=false travelTimeInSeconds fortfarande inkluderar fördröjningen på grund av trafik. Om DepartAt är i framtiden beräknas restiden med tidsberoende historiska trafikdata.

RouteOptimizedWaypoint

Optimerat vägpunktsobjekt.

Name Typ Description
optimizedIndex

integer

Optimerat vägpunktsindex från systemet.

providedIndex

integer

Vägpunktsindex som tillhandahålls av användaren.

RouteReport

Rapporterar de effektiva inställningar som används i det aktuella anropet.

Name Typ Description
effectiveSettings

EffectiveSetting[]

Effektiva parametrar eller data som används när du anropar det här routnings-API:et.

RouteRepresentationForBestOrder

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

Name Typ Description
none

string

Innehåller endast de optimerade waypointindexen men inkluderar inte routningsgeometrin i svaret. Det här parametervärdet kan endast användas tillsammans med computeBestOrder=true.

polyline

string

Innehåller routningsgeometri i svaret.

summaryOnly

string

Sammanfattning per polyline men exkludera punktgeometrielementen för vägarna i svaret.

RouteSection

Vägavsnitt innehåller ytterligare information om delar av en väg. Varje avsnitt innehåller minst elementen startPointIndex, endPointIndexoch sectionType.

Name Typ Description
delayInSeconds

integer

Fördröjning i sekunder som orsakas av incidenten.

effectiveSpeedInKmh

integer

Incidentens effektiva hastighet i km/h, i genomsnitt över hela dess längd.

endPointIndex

integer

Index för den sista punkten (förskjutning 0) i den väg som det här avsnittet gäller för.

magnitudeOfDelay

DelayMagnitude

Omfattningen av fördröjningen som orsakas av incidenten. Dessa värden motsvarar värdena i svarsfältet ty för api:et Hämta information om trafikincidenter.

sectionType

ResponseSectionType

Avsnittstyper för det rapporterade vägsvaret

simpleCategory

SimpleCategory

Typ av incident. Kan för närvarande vara JAM, ROAD_WORK, ROAD_CLOSURE eller OTHER. Mer information finns i "tec".

startPointIndex

integer

Index för den första punkten (förskjutning 0) i den väg som det här avsnittet gäller för.

tec

RouteSectionTec

Information om trafikhändelsen med hjälp av definitioner i TPEG2-TEC- standard. Kan innehålla effectCode och orsakar element.

travelMode

ResponseTravelMode

Reseläge för den beräknade vägen. Värdet anges till other om det begärda transportsättet inte är möjligt i det här avsnittet

RouteSectionTec

Information om trafikhändelsen med hjälp av definitioner i TPEG2-TEC- standard. Kan innehålla effectCode och orsakar element.

Name Typ Description
causes

RouteSectionTecCause[]

Orsakar matris

effectCode

integer

Effekten på trafikflödet. Innehåller ett värde i tabellen tec001:EffectCode enligt definitionen i TPEG2-TEC- standard. Kan användas för att färgkoda trafikhändelser efter allvarlighetsgrad.

RouteSectionTecCause

Orsaken till trafikhändelsen. Kan innehålla mainCauseCode- och subCauseCode-element. Kan användas för att definiera ikonografi och beskrivningar.

Name Typ Description
mainCauseCode

integer

Den främsta orsaken till trafikhändelsen. Innehåller ett värde i tabellen tec002:CauseCode enligt definitionen i TPEG2-TEC- standard.

subCauseCode

integer

Undercause för trafikhändelsen. Innehåller ett värde i underorsakstabellen som definieras av mainCauseCode enligt definitionen i TPEG2-TEC- standard.

RouteSummary

Sammanfattningsobjekt

Name Typ Description
arrivalTime

string

Beräknad ankomsttid för rutten eller benet. Tiden är i UTC.

departureTime

string

Den beräknade avgångstiden för rutten eller benet. Tiden är i UTC.

lengthInMeters

integer

Egenskapen Längd i meter

trafficDelayInSeconds

integer

Uppskattad fördröjning i sekunder som orsakas av realtidsincidenter enligt trafikinformation. För rutter som planeras med avgångstid i framtiden är förseningar alltid 0. Om du vill returnera ytterligare restider med hjälp av olika typer av trafikinformation måste parameterberäkningTravelTimeFor=alla läggas till.

travelTimeInSeconds

integer

Uppskattad restid i sekundegenskap som inkluderar fördröjningen på grund av realtidstrafik. Observera att även när traffic=false travelTimeInSeconds fortfarande inkluderar fördröjningen på grund av trafik. Om DepartAt är i framtiden beräknas restiden med tidsberoende historiska trafikdata.

RouteType

Den typ av väg som begärs.

Name Typ Description
eco

string

En väg som balanseras av ekonomi och hastighet.

fastest

string

Den snabbaste vägen.

shortest

string

Den kortaste vägen efter 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 hilliness och windingness för hur du ställer in detta. Det finns en gräns på 900 km på rutter som planeras med routeType=spännande

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

Name Typ Description
carTrain

string

Delar av rutten som är bilar eller tåg.

carpool

string

Delar av den väg som kräver användning av samåkningsbanor (HOV/High Occupancy Vehicle).

country

string

Avsnitt som anger vilka länder/regioner vägen finns i.

ferry

string

Delar av rutten som är färjor.

motorway

string

Delar av rutten som är motorvägar.

pedestrian

string

Delar av rutten som endast är lämpliga för fotgängare.

tollRoad

string

Delar av rutten som kräver att en avgift betalas.

tollVignette

string

Delar av vägen som kräver att en avgiftsbelagd vinjett finns.

traffic

string

Delar av vägen som innehåller trafikinformation.

travelMode

string

Avsnitt i förhållande till parametern request travelMode.

tunnel

string

Delar av vägen som är tunnlar.

urban

string

Delar av rutten som finns i stadsområden.

SimpleCategory

Typ av incident. Kan för närvarande vara JAM, ROAD_WORK, ROAD_CLOSURE eller OTHER. Mer information finns i "tec".

Name Typ Description
JAM

string

Trafikstockning.

OTHER

string

Annan.

ROAD_CLOSURE

string

Vägavstängning.

ROAD_WORK

string

Vägarbete.

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.

Name Typ Description
bicycle

string

De returnerade vägarna är optimerade för cyklar, inklusive användning av cykelbanor.

bus

string

De returnerade rutterna ä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.

pedestrian

string

De returnerade vägarna är optimerade för fotgängare, inklusive användning av trottoarer.

taxi

string

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

truck

string

De returnerade rutterna ä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 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.

Name Typ Description
USHazmatClass1

string

Sprängämnen

USHazmatClass2

string

Komprimerad gas

USHazmatClass3

string

Brandfarliga vätskor

USHazmatClass4

string

Brandfarliga fasta ämnen

USHazmatClass5

string

Oxidatorer

USHazmatClass6

string

Gifter

USHazmatClass7

string

Radioaktiv

USHazmatClass8

string

Frätande

USHazmatClass9

string

Diverse

otherHazmatExplosive

string

Sprängämnen

otherHazmatGeneral

string

Diverse

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