Route - Get Route Directions

Referentie

Service:: Maps

API-versie:: 1.0

Gebruik dit voor het berekenen van een route tussen een opgegeven oorsprong en bestemming, waarbij eventuele opgegeven waypoints worden doorgegeven.

De Get Route Directions-API is een HTTP-GET-aanvraag die een route retourneert tussen een oorsprong en een bestemming, waarbij waypoints worden doorgegeven, indien opgegeven. De route houdt rekening met factoren zoals huidig verkeer en de typische verkeerssnelheden op de aangevraagde dag van de week en het tijdstip van de dag.

De geretourneerde informatie omvat de afstand, de geschatte reistijd en een weergave van de routegeometrie. Aanvullende routeringsinformatie, zoals geoptimaliseerde waypointvolgorde of turn by turn-instructies, is ook beschikbaar, afhankelijk van de geselecteerde opties.

Routeringsservice biedt een set parameters voor een gedetailleerde beschrijving van een voertuigspecifiek verbruiksmodel. Zie Consumption Modelvoor meer informatie.

GET https://atlas.microsoft.com/route/directions/{format}?api-version=1.0&query={query}

Met optionele parameters:

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

Name	In	Vereist	Type	Description
format	path	True	ResponseFormat	Gewenste indeling van het antwoord. De waarde kan json- of xml-zijn.
api-version	query	True	string	Versienummer van Azure Maps-API.
query	query	True	string	De coördinaten waarmee de route wordt berekend, gescheiden door een dubbele punt. Er zijn minimaal twee coördinaten vereist. De eerste is de oorsprong en het laatste is de bestemming van de route. Optionele coördinaten in-between fungeren als WayPoints in de route. U kunt maximaal 150 WayPoints doorgeven.
accelerationEfficiency	query		number double	Hiermee geeft u de efficiëntie van het converteren van chemische energie opgeslagen in brandstof naar kinetische energie wanneer het voertuig versnelt (d.w.w.v. De KinetischeEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed wordt verkregen door verbruikte brandstof om te zetten in chemische energie met behulp van fuelEnergyDensityInMJoulesPerLiter. Moet worden gekoppeld aan vertragingsefficiency. Het toegestane bereik van waarden is 0,0 tot 1/decelerationEfficiency. Verstandige waarden: voor verbrandingsmodel : 0,33, voor elektrisch model : 0,66
alternativeType	query		AlternativeRouteType	Bepaalt de optimale werking, met betrekking tot de opgegeven planningscriteria, van de berekende alternatieven in vergelijking met de referentieroute.
arriveAt	query		string date-time	De datum en tijd van aankomst op het doelpunt dat is opgemaakt als een `dateTime`-waarde zoals gedefinieerd in RFC 3339, sectie 5,6, met een optionele tijdzone-offset. Wanneer er geen tijdzone-offset wordt opgegeven, wordt ervan uitgegaan dat dit van het doelpunt is. Voorbeelden: 2023-12-19T16:39:57 2023-12-19T16:39:57-08:00 De parameter `arriveAt` kan niet worden gebruikt in combinatie met `departAt`, `minDeviationDistance` of `minDeviationTime`.
auxiliaryPowerInkW	query		number double	Hiermee geeft u de hoeveelheid verbruikt vermogen voor ondersteunende systemen, in kilowatts (kW). Het kan worden gebruikt om verbruik op te geven als gevolg van apparaten en systemen zoals AC-systemen, radio, verwarming, enz. Zinnige waarden : 1,7
auxiliaryPowerInLitersPerHour	query		number double	Hiermee geeft u de hoeveelheid verbruikte brandstof voor ondersteunende systemen van het voertuig, in liter per uur. Het kan worden gebruikt om verbruik op te geven als gevolg van apparaten en systemen zoals AC-systemen, radio, verwarming, enz. Zinnige waarden : 0.2
avoid	query		RouteAvoidType[]	Hiermee geeft u iets op dat de routeberekening moet proberen te vermijden bij het bepalen van de route. Kan meerdere keren in één aanvraag worden opgegeven, bijvoorbeeld '&vermijd=snelwegen&vermijden=tollRoads&avoid=veerboten'. In routebereikaanvragen mag de waarde alreadyUsedRoads niet worden gebruikt.
computeBestOrder	query		boolean	Rangschik de route-waypoints opnieuw met behulp van een snel heuristisch algoritme om de lengte van de route te verminderen. Geeft de beste resultaten wanneer deze worden gebruikt in combinatie met routeType kortste. U ziet dat oorsprong en bestemming worden uitgesloten van de geoptimaliseerde waypoint-indexen. Als u oorsprong en bestemming in het antwoord wilt opnemen, verhoogt u alle indexen met 1 om rekening te houden met de oorsprong en voegt u vervolgens de bestemming toe als de uiteindelijke index. Mogelijke waarden zijn waar of onwaar. True berekent indien mogelijk een betere volgorde, maar mag niet worden gebruikt in combinatie met de waarde maxAlternatives die groter is dan 0 of in combinatie met cirkel-waypoints. False gebruikt de locaties in de opgegeven volgorde en mag niet worden gebruikt in combinatie met routeRepresentation geen.
computeTravelTimeFor	query		ComputeTravelTime	Hiermee geeft u op of er extra reistijden moeten worden geretourneerd met behulp van verschillende soorten verkeersinformatie (geen, historisch, live) en de standaard best-schatting reistijd.
constantSpeedConsumptionInkWhPerHundredkm	query		string	Hiermee geeft u het snelheidsafhankelijke onderdeel van het verbruik. Geleverd als een niet-geordende lijst met snelheids-/verbruiksfrequentieparen. De lijst definieert punten op een verbruikscurve. Verbruikstarieven voor snelheden die niet in de lijst staan, worden als volgt gevonden: door lineaire interpolatie, als de opgegeven snelheid tussen twee snelheden in de lijst ligt door lineaire extrapolatie anders, uitgaande van een constante (ΔConsumption/ΔSpeed) die wordt bepaald door de dichtstbijzijnde twee punten in de lijst De lijst moet tussen 1 en 25 punten (inclusief) bevatten en mag geen dubbele punten voor dezelfde snelheid bevatten. Als het slechts één punt bevat, wordt de verbruikssnelheid van dat punt zonder verdere verwerking gebruikt. Het verbruik dat is opgegeven voor de grootste snelheid moet groter zijn dan of gelijk zijn aan die van de voorlaatste snelheid. Dit zorgt ervoor dat extrapolatie niet leidt tot negatieve verbruikstarieven. Op dezelfde manier kunnen verbruikswaarden die zijn opgegeven voor de twee kleinste snelheden in de lijst, niet leiden tot een negatief verbruik voor een kleinere snelheid. Het geldige bereik voor de verbruikswaarden (uitgedrukt in kWh/100km) ligt tussen 0,01 en 100000,0. Verstandige waarden: 50,8.2:130,21.3 Deze parameter is vereist voor elektrische verbruiksmodel.
constantSpeedConsumptionInLitersPerHundredkm	query		string	Hiermee geeft u het snelheidsafhankelijke onderdeel van het verbruik. Wordt geleverd als een niet-geordende lijst met door dubbele punt gescheiden snelheidsparen & verbruiksfrequentieparen. De lijst definieert punten op een verbruikscurve. Verbruikstarieven voor snelheden die niet in de lijst staan, worden als volgt gevonden: door lineaire interpolatie, als de opgegeven snelheid tussen twee snelheden in de lijst ligt door lineaire extrapolatie anders, uitgaande van een constante (ΔConsumption/ΔSpeed) die wordt bepaald door de dichtstbijzijnde twee punten in de lijst De lijst moet tussen 1 en 25 punten (inclusief) bevatten en mag geen dubbele punten voor dezelfde snelheid bevatten. Als het slechts één punt bevat, wordt de verbruikssnelheid van dat punt zonder verdere verwerking gebruikt. Het verbruik dat is opgegeven voor de grootste snelheid moet groter zijn dan of gelijk zijn aan die van de voorlaatste snelheid. Dit zorgt ervoor dat extrapolatie niet leidt tot negatieve verbruikstarieven. Op dezelfde manier kunnen verbruikswaarden die zijn opgegeven voor de twee kleinste snelheden in de lijst, niet leiden tot een negatief verbruik voor een kleinere snelheid. Het geldige bereik voor de verbruikswaarden (uitgedrukt in l/100km) ligt tussen 0,01 en 100000,0. Verstandige waarden: 50,6.3:130,11,5 Opmerking: deze parameter is vereist voor het verbrandingsverbruiksmodel.
currentChargeInkWh	query		number double	Hiermee geeft u de huidige elektrische energietoevoer in kilowatturen (kWh). Deze parameter bestaat samen met maxChargeInkWh parameter. Het toegestane waardenbereik is 0,0 tot maxChargeInkWh. Verstandige waarden : 43
currentFuelInLiters	query		number double	Hiermee geeft u de huidige toevoer van brandstof in liter. Verstandige waarden : 55
decelerationEfficiency	query		number double	Hiermee geeft u de efficiëntie van het converteren van kinetische energie naar opgeslagen (niet verbruikte) brandstof wanneer het voertuig vertraagt (d.w.w.v. ChemicalEnergySaved/KinetischeEnergyLost). ChemicalEnergySaved wordt verkregen door opgeslagen (niet verbruikte) brandstof te converteren naar energie met behulp van fuelEnergyDensityInMJoulesPerLiter. Moet worden gekoppeld aan accelerationEfficiency. Het toegestane bereik van waarden is 0,0 tot 1/accelerationEfficiency. Verstandige waarden: voor verbrandingsmodel : 0,83, voor elektrisch model : 0,91
departAt	query		string date-time	De datum en tijd van vertrek van het oorspronkelijke punt die zijn opgemaakt als een `dateTime` waarde zoals gedefinieerd in RFC 3339, sectie 5,6, met een optionele tijdzone-offset. Wanneer er geen tijdzone-offset is opgegeven, wordt ervan uitgegaan dat deze van het oorspronkelijke punt is. Standaardwaarde: nu Andere waarde: `dateTime` Voorbeelden: 2023-12-19T16:39:57 2023-12-19T16:39:57-08:00 De parameter `departAt` kan niet worden gebruikt in combinatie met `arriveAt`.
downhillEfficiency	query		number double	Hiermee geeft u de efficiëntie van het converteren van potentiële energie naar opgeslagen (niet verbruikte) brandstof wanneer het voertuig verhoging verliest (d.w. ChemicalEnergySaved/PotentialEnergyLost). ChemicalEnergySaved wordt verkregen door opgeslagen (niet verbruikte) brandstof te converteren naar energie met behulp van fuelEnergyDensityInMJoulesPerLiter. Moet worden gekoppeld aan uphillEfficiency. Het toegestane waardenbereik is 0,0 tot 1/uphillEfficiency. Verstandige waarden: voor verbrandingsmodel : 0,51, voor elektrisch model : 0,73
fuelEnergyDensityInMJoulesPerLiter	query		number double	Hiermee geeft u de hoeveelheid chemische energie opgeslagen in één liter brandstof in megajoules (MJ). Het wordt gebruikt in combinatie met de *Efficiency parameters voor conversies tussen opgeslagen of verbruikte energie en brandstof. Energiedichtheid is bijvoorbeeld 34,2 MJ/l voor benzine en 35,8 MJ/l voor dieselbrandstof. Deze parameter is vereist als een *Efficiency parameter is ingesteld. Verstandige waarden : 34.2
hilliness	query		InclineLevel	Mate van heuveligheid voor spannende route. Deze parameter kan alleen worden gebruikt in combinatie met `routeType`=spannende.
instructionsType	query		RouteInstructionsType	Indien opgegeven, worden instructies geretourneerd. Houd er rekening mee dat de parameter instructionsType niet kan worden gebruikt in combinatie met routeRepresentation=none.
language	query		string	De taalparameter bepaalt de taal van de richtlijnenberichten. De juiste zelfstandige naamwoorden (de namen van straten, pleinen, enzovoort) worden geretourneerd in de opgegeven taal, of als dat niet beschikbaar is, worden ze geretourneerd in een beschikbare taal die zich er dichtbij bevindt. Toegestane waarden zijn (een subset van) de IETF-taaltags. De momenteel ondersteunde talen worden vermeld in de sectie Ondersteunde talen. Standaardwaarde: en-GB
maxAlternatives	query		integer	Het aantal gewenste alternatieve routes dat moet worden berekend. Standaard: 0, minimum: 0 en maximum: 5
maxChargeInkWh	query		number double	Hiermee geeft u de maximale elektrische energietoevoer in kilowatturen (kWh) op die in de batterij van het voertuig kunnen worden opgeslagen. Deze parameter bestaat samen met currentChargeInkWh parameter. De minimumwaarde moet groter dan of gelijk zijn aan currentChargeInkWh. Verstandige waarden : 85
minDeviationDistance	query		integer	Alle alternatieve routes die worden geretourneerd, volgen de referentieroute (zie sectie POST-aanvragen) vanaf het oorspronkelijke punt van de calculateRoute-aanvraag voor ten minste dit aantal meters. Kan alleen worden gebruikt bij het reconstrueren van een route. De parameter minDeviationDistance kan niet worden gebruikt in combinatie met arriveAt
minDeviationTime	query		integer	Alle alternatieve routes die worden geretourneerd, volgen de referentieroute (zie sectie POST-aanvragen) vanaf het oorspronkelijke punt van de calculateRoute-aanvraag gedurende ten minste dit aantal seconden. Kan alleen worden gebruikt bij het reconstrueren van een route. De parameter minDeviationTime kan niet worden gebruikt in combinatie met arriveAt. De standaardwaarde is 0. Als u )minDeviationTime_ instelt op een waarde die groter is dan nul, heeft dit de volgende gevolgen: Het oorspronkelijke punt van de calculateRoute-aanvraag moet zich op de invoerreferentieroute (of zeer dichtbij) bevindt. Als dit niet het geval is, wordt er een fout geretourneerd. Het oorspronkelijke punt hoeft zich echter niet aan het begin van de invoerreferentieroute te bevinden (het kan worden beschouwd als de huidige voertuigpositie op de referentieroute). De referentieroute, geretourneerd als de eerste route in de calculateRoute Response, begint op het oorspronkelijke punt dat is opgegeven in de calculateRoute Request. Het eerste deel van de invoerreferentieroute totdat het oorspronkelijke punt wordt uitgesloten van het antwoord. De waarden van minDeviationDistance en minDeviationTime bepalen hoe ver alternatieve routes gegarandeerd de referentieroute vanaf het beginpunt volgen. De route moet vertrekkenDegebruiken. De vehicleHeading wordt genegeerd.
report	query		Report	Hiermee geeft u op welke gegevens moeten worden gerapporteerd voor diagnosedoeleinden. De enige mogelijke waarde is effectiveSettings. Rapporteert de effectieve parameters of gegevens die worden gebruikt bij het aanroepen van de API. In het geval van standaardparameters wordt de standaardwaarde weergegeven wanneer de parameter niet is opgegeven door de aanroeper.
routeRepresentation	query		RouteRepresentationForBestOrder	Hiermee geeft u de weergave van de set routes opgegeven als antwoord.
routeType	query		RouteType	Het type route aangevraagd.
sectionType	query		SectionType[]	Hiermee geeft u op welke sectietypen worden gerapporteerd in het routeantwoord. Als bijvoorbeeld sectionType = voetgangers de secties die alleen geschikt zijn voor voetgangers, worden geretourneerd. Kan meerdere keren worden opgegeven in één aanvraag, bijvoorbeeld '§ionType=carTrain§ionType=voetgangers§ionType=snelweg'. Het standaard sectionType verwijst naar de travelMode-invoer. Standaard is travelMode ingesteld op auto
traffic	query		boolean	Mogelijke waarden: true - Houd rekening met alle beschikbare verkeersinformatie tijdens routering false : huidige verkeersgegevens tijdens routering negeren. Houd er rekening mee dat hoewel de huidige verkeersgegevens tijdens de routering worden genegeerd, het effect van historisch verkeer op effectieve wegsnelheden nog steeds wordt opgenomen.
travelMode	query		TravelMode	De reismodus voor de aangevraagde route. Als dit niet is gedefinieerd, is de standaardwaarde 'auto'. Houd er rekening mee dat de aangevraagde travelMode mogelijk niet beschikbaar is voor de hele route. Wanneer de aangevraagde travelMode niet beschikbaar is voor een bepaalde sectie, is het element travelMode van het antwoord voor die sectie 'overig'. Houd er rekening mee dat reismodi bus, motorfiets, taxi en busje beta-functionaliteit zijn. Volledige beperkingsgegevens zijn niet beschikbaar in alle gebieden.
uphillEfficiency	query		number double	Hiermee geeft u de efficiëntie van het converteren van chemische energie opgeslagen in brandstof naar potentiële energie wanneer het voertuig verhoging (d.w.w.v. PotentialEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed wordt verkregen door verbruikte brandstof om te zetten in chemische energie met behulp van fuelEnergyDensityInMJoulesPerLiter. Moet worden gekoppeld aan downhillEfficiency. Het toegestane waardenbereik is 0,0 tot 1/downhillEfficiency. Zinnige waarden: voor verbrandingsmodel : 0,27, voor elektrisch model : 0,74
vehicleAxleWeight	query		integer	Gewicht per as van het voertuig in kg. Een waarde van 0 betekent dat gewichtsbeperkingen per as niet worden overwogen.
vehicleCommercial	query		boolean	Of het voertuig wordt gebruikt voor commerciële doeleinden. Bedrijfsvoertuigen mogen mogelijk niet op sommige wegen rijden.
vehicleEngineType	query		VehicleEngineType	Motortype van het voertuig. Wanneer een gedetailleerd verbruiksmodel is opgegeven, moet het consistent zijn met de waarde van vehicleEngineType.
vehicleHeading	query		integer	De richtingsrichting van het voertuig in graden beginnend bij waar Noord en doorgaan in rechtsom. Het noorden is 0 graden, het oosten is 90 graden, het zuiden is 180 graden, west is 270 graden. Mogelijke waarden 0-359
vehicleHeight	query		number double	Hoogte van het voertuig in meters. Een waarde van 0 betekent dat hoogtebeperkingen niet worden overwogen.
vehicleLength	query		number double	Lengte van het voertuig in meters. Een waarde van 0 betekent dat lengtebeperkingen niet worden overwogen.
vehicleLoadType	query		VehicleLoadType	Soorten ladingen die kunnen worden geclassificeerd als gevaarlijke materialen en beperkt zijn van sommige wegen. Beschikbare vehicleLoadType-waarden zijn US Hazmat-klassen 1 tot en met 9, plus algemene classificaties voor gebruik in andere landen/regio's. Waarden die beginnen met USHazmat zijn voor amerikaanse routering, terwijl andereHazmat moet worden gebruikt voor alle andere landen/regio's. vehicleLoadType kan meerdere keren worden opgegeven. Deze parameter wordt momenteel alleen in aanmerking genomen voor travelMode=truck.
vehicleMaxSpeed	query		integer	Maximumsnelheid van het voertuig in km/uur. De maximale snelheid in het voertuigprofiel wordt gebruikt om te controleren of een voertuig is toegestaan op snelwegen. Een waarde van 0 betekent dat een passende waarde voor het voertuig wordt bepaald en toegepast tijdens de routeplanning. Een niet-nulwaarde kan tijdens het plannen van de route worden overschreven. De huidige verkeersstroom is bijvoorbeeld 60 km/uur. Als de maximumsnelheid van het voertuig is ingesteld op 50 km/uur, zal de routeringsmotor rekening houden met 60 km/uur, aangezien dit de huidige situatie is. Als de maximumsnelheid van het voertuig wordt opgegeven als 80 km/uur, maar de huidige verkeersstroom 60 km/uur is, gebruikt de routeringsmotor opnieuw 60 km/uur.
vehicleWeight	query		integer	Gewicht van het voertuig in kilogram. Dit is verplicht als een van de Efficiëntieparameters is ingesteld. Het moet strikt positief zijn wanneer deze wordt gebruikt in de context van het verbruiksmodel. Gewichtsbeperkingen worden overwogen. Als er geen gedetailleerde verbruiksmodel* is opgegeven en de waarde van vehicleWeight niet nul is, worden gewichtsbeperkingen overwogen. In alle andere gevallen wordt deze parameter genegeerd. Verstandige waarden: voor verbrandingsmodel : 1600, voor elektrisch model : 1900
vehicleWidth	query		number double	Breedte van het voertuig in meters. Een waarde van 0 betekent dat breedtebeperkingen niet worden overwogen.
windingness	query		WindingnessLevel	Hoogte van bochten voor spannende route. Deze parameter kan alleen worden gebruikt in combinatie met `routeType`=spannende.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-id		string	Hiermee geeft u op welk account is bedoeld voor gebruik in combinatie met het Microsoft Entra ID-beveiligingsmodel. Het vertegenwoordigt een unieke id voor het Azure Maps-account en kan worden opgehaald uit de Account-API van het Azure Maps-beheervlak. Zie de volgende artikelen voor hulp voor het gebruik van Microsoft Entra ID-beveiliging in Azure Maps.

Antwoorden

Name	Type	Description
200 OK	RouteDirections	OK
Other Status Codes	ErrorResponse	Er is een onverwachte fout opgetreden.

Beveiliging

AADToken

Dit zijn de Microsoft Entra OAuth 2.0 Flows. Wanneer deze is gekoppeld aan op rollen gebaseerd toegangsbeheer van Azure kan het worden gebruikt om de toegang tot Azure Maps REST API's te beheren. Op rollen gebaseerd toegangsbeheer van Azure wordt gebruikt om toegang aan te wijzen tot een of meer Azure Maps-resourceaccounts of subresources. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.

Voor het implementeren van scenario's raden we u aan om verificatieconceptente bekijken. Kortom, deze beveiligingsdefinitie biedt een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen uitvoeren voor specifieke API's en bereiken.

Notities

Deze beveiligingsdefinitie vereist het gebruik van de x-ms-client-id-header om aan te geven tot welke Azure Maps-resource de toepassing toegang aanvraagt. Dit kan worden verkregen uit de Maps Management API-.

De Authorization URL is specifiek voor het exemplaar van de openbare Azure-cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Microsoft Entra ID-configuraties. * Het op rollen gebaseerde toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's. * Gebruik van de Azure Maps Web SDK maakt configuratiegebaseerde installatie van een toepassing mogelijk voor meerdere gebruiksscenario's.

Zie Overzicht van Microsoft Identity Platformvoor meer informatie over het Microsoft Identity Platform.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

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

subscription-key

Dit is een gedeelde sleutel die wordt ingericht wanneer u Een Azure Maps-account maken in Azure Portal of met behulp van PowerShell, CLI, Azure SDK's of REST API.

Met deze sleutel heeft elke toepassing toegang tot alle REST API's. Met andere woorden, deze sleutel kan worden gebruikt als een hoofdsleutel in het account waarin ze worden uitgegeven.

Voor openbaar blootgestelde toepassingen is het raadzaam om de vertrouwelijke clienttoepassingen te gebruiken benadering voor toegang tot Azure Maps REST API's, zodat uw sleutel veilig kan worden opgeslagen.

Type: apiKey
In: query

SAS Token

Dit is een shared access Signature-token dat wordt gemaakt op basis van de bewerking List SAS op de Azure Maps-resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.

Met dit token is elke toepassing gemachtigd voor toegang met op rollen gebaseerd toegangsbeheer van Azure en gedetailleerd beheer tot de vervaldatum, snelheid en regio(s) van gebruik voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen toe te staan toegang op een veiligere manier te beheren dan de gedeelde sleutel.

Voor openbaar blootgestelde toepassingen wordt aangeraden een specifieke lijst met toegestane origins te configureren voor de resource van het Account toewijzen om het genereren van misbruik te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

Successfully retrieve a route between an origin and a destination

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 200

{
  "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"
        }
      ]
    }
  ]
}

Definities

Name	Description
AlternativeRouteType	Bepaalt de optimale werking, met betrekking tot de opgegeven planningscriteria, van de berekende alternatieven in vergelijking met de referentieroute.
ComputeTravelTime	Hiermee geeft u op of er extra reistijden moeten worden geretourneerd met behulp van verschillende soorten verkeersinformatie (geen, historisch, live) en de standaard best-schatting reistijd.
DelayMagnitude	De omvang van de vertraging die wordt veroorzaakt door het incident. Deze waarden komen overeen met de waarden van het antwoordveld van de Traffic Incident Detail APIophalen.
DrivingSide	Geeft links-vs. rechts rijden aan op het punt van de manoeuvreer.
EffectiveSetting	Effectieve parameter of gegevens die worden gebruikt bij het aanroepen van deze Route-API.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
GuidanceInstructionType	Type instructie, bijvoorbeeld omdraaien of wijzigen van wegformulier.
GuidanceManeuver	Een code die de manoeuvre identificeert.
InclineLevel	Mate van heuveligheid voor spannende route. Deze parameter kan alleen worden gebruikt in combinatie met `routeType`=spannende.
JunctionType	Het type verbindingspunt waar de manoeuvre plaatsvindt. Voor grotere rotondes worden twee afzonderlijke instructies gegenereerd voor het binnenkomen en verlaten van de rotonde.
LatLongPair	Een locatie die wordt weergegeven als een breedtegraad en lengtegraad.
Report	Hiermee geeft u op welke gegevens moeten worden gerapporteerd voor diagnosedoeleinden. De enige mogelijke waarde is effectiveSettings. Rapporteert de effectieve parameters of gegevens die worden gebruikt bij het aanroepen van de API. In het geval van standaardparameters wordt de standaardwaarde weergegeven wanneer de parameter niet is opgegeven door de aanroeper.
ResponseFormat	Gewenste indeling van het antwoord. De waarde kan json- of xml-zijn.
ResponseSectionType	Sectietypen van het gerapporteerde routeantwoord
ResponseTravelMode	De reismodus voor de berekende route. De waarde wordt ingesteld op `other` als de aangevraagde transportmodus niet mogelijk is in deze sectie
Route
RouteAvoidType	Hiermee geeft u iets op dat de routeberekening moet proberen te vermijden bij het bepalen van de route. Kan meerdere keren in één aanvraag worden opgegeven, bijvoorbeeld '&vermijd=snelwegen&vermijden=tollRoads&avoid=veerboten'. In routebereikaanvragen mag de waarde alreadyUsedRoads niet worden gebruikt.
RouteDirections	Dit object wordt geretourneerd door een geslaagde aanroep Routebeschrijving
RouteGuidance	Bevat richtlijnen gerelateerde elementen. Dit veld is alleen aanwezig wanneer er richtlijnen zijn aangevraagd en beschikbaar is.
RouteInstruction	Een reeks kenmerken die een manoeuvre beschrijven, bijvoorbeeld 'Rechts rechts', 'Links blijven', 'Neem de veerboot', 'Neem de snelweg', 'Arrive'.
RouteInstructionGroup	Hiermee wordt een reeks instructie-elementen gegroepeerd die aan elkaar zijn gerelateerd. Het reeksbereik is beperkt met firstInstructionIndex en lastInstructionIndex. Wanneer door mensen leesbare tekstberichten worden aangevraagd voor richtlijnen (instructionType=text of gelabeld), heeft de instructionGroup een samenvattingsbericht geretourneerd wanneer deze beschikbaar is.
RouteInstructionsType	Indien opgegeven, worden instructies geretourneerd. Houd er rekening mee dat de parameter instructionsType niet kan worden gebruikt in combinatie met routeRepresentation=none.
RouteLeg	Een beschrijving van een deel van een route, bestaande uit een lijst met punten. Elk extra waypoint dat in de aanvraag wordt opgegeven, resulteert in een extra been in de geretourneerde route.
RouteLegSummary	Overzichtsobject voor routesectie.
RouteOptimizedWaypoint	Geoptimaliseerd way point-object.
RouteReport	Rapporteert de effectieve instellingen die worden gebruikt in de huidige aanroep.
RouteRepresentationForBestOrder	Hiermee geeft u de weergave van de set routes opgegeven als antwoord.
RouteSection	Routesecties bevatten aanvullende informatie over onderdelen van een route. Elke sectie bevat ten minste de elementen `startPointIndex`, `endPointIndex`en `sectionType`.
RouteSectionTec	Details van de verkeersgebeurtenis met behulp van definities in de TPEG2-TEC standaard. Kan effectCode bevatten en elementen veroorzaken.
RouteSectionTecCause	De oorzaak van de verkeers gebeurtenis. Kan mainCauseCode- en subCauseCode-elementen bevatten. Kan worden gebruikt om iconografie en beschrijvingen te definiëren.
RouteSummary	Samenvattingsobject
RouteType	Het type route aangevraagd.
SectionType	Hiermee geeft u op welke sectietypen worden gerapporteerd in het routeantwoord. Als bijvoorbeeld sectionType = voetgangers de secties die alleen geschikt zijn voor voetgangers, worden geretourneerd. Kan meerdere keren worden opgegeven in één aanvraag, bijvoorbeeld '§ionType=carTrain§ionType=voetgangers§ionType=snelweg'. Het standaard sectionType verwijst naar de travelMode-invoer. Standaard is travelMode ingesteld op auto
SimpleCategory	Type van het incident. Kan momenteel JAM, ROAD_WORK, ROAD_CLOSURE of OTHER zijn. Zie "tec" voor gedetailleerde informatie.
TravelMode	De reismodus voor de aangevraagde route. Als dit niet is gedefinieerd, is de standaardwaarde 'auto'. Houd er rekening mee dat de aangevraagde travelMode mogelijk niet beschikbaar is voor de hele route. Wanneer de aangevraagde travelMode niet beschikbaar is voor een bepaalde sectie, is het element travelMode van het antwoord voor die sectie 'overig'. Houd er rekening mee dat reismodi bus, motorfiets, taxi en busje beta-functionaliteit zijn. Volledige beperkingsgegevens zijn niet beschikbaar in alle gebieden.
VehicleEngineType	Motortype van het voertuig. Wanneer een gedetailleerd verbruiksmodel is opgegeven, moet het consistent zijn met de waarde van vehicleEngineType.
VehicleLoadType	Soorten ladingen die kunnen worden geclassificeerd als gevaarlijke materialen en beperkt zijn van sommige wegen. Beschikbare vehicleLoadType-waarden zijn US Hazmat-klassen 1 tot en met 9, plus algemene classificaties voor gebruik in andere landen/regio's. Waarden die beginnen met USHazmat zijn voor amerikaanse routering, terwijl andereHazmat moet worden gebruikt voor alle andere landen/regio's. vehicleLoadType kan meerdere keren worden opgegeven. Deze parameter wordt momenteel alleen in aanmerking genomen voor travelMode=truck.
WindingnessLevel	Hoogte van bochten voor spannende route. Deze parameter kan alleen worden gebruikt in combinatie met `routeType`=spannende.

AlternativeRouteType

Bepaalt de optimale werking, met betrekking tot de opgegeven planningscriteria, van de berekende alternatieven in vergelijking met de referentieroute.

Name	Type	Description
anyRoute	string	Sta toe dat elke alternatieve route wordt geretourneerd, ongeacht hoe deze zich verhoudt tot de referentieroute in termen van optimale werking.
betterRoute	string	Retourneer alleen een alternatieve route als deze beter is dan de referentieroute volgens de opgegeven planningscriteria.

ComputeTravelTime

Hiermee geeft u op of er extra reistijden moeten worden geretourneerd met behulp van verschillende soorten verkeersinformatie (geen, historisch, live) en de standaard best-schatting reistijd.

Name	Type	Description
all	string	Berekent reistijden voor alle typen verkeersinformatie en geeft alle resultaten op in de velden noTrafficTravelTimeInSeconds, historicTrafficTravelTimeInSeconds en liveTrafficIncidentsTravelTimeInSeconds die worden opgenomen in de samenvattingen in het routeantwoord.
none	string	Berekent geen extra reistijden.

DelayMagnitude

De omvang van de vertraging die wordt veroorzaakt door het incident. Deze waarden komen overeen met de waarden van het antwoordveld van de Traffic Incident Detail APIophalen.

Name	Type	Description
0	string	Onbekend.
1	string	Minderjarige.
2	string	Gematigd.
3	string	Majoor.
4	string	Niet gedefinieerd, gebruikt voor wegsluitingen en andere onbepaalde vertragingen.

DrivingSide

Geeft links-vs. rechts rijden aan op het punt van de manoeuvreer.

Name	Type	Description
LEFT	string	Linkerkant.
RIGHT	string	Rechterzijde.

EffectiveSetting

Effectieve parameter of gegevens die worden gebruikt bij het aanroepen van deze Route-API.

Name	Type	Description
key	string	Naam van de gebruikte parameter.
value	string	Waarde van de gebruikte parameter.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

GuidanceInstructionType

Type instructie, bijvoorbeeld omdraaien of wijzigen van wegformulier.

Name	Type	Description
DIRECTION_INFO	string	Richtingsinformatie.
LOCATION_ARRIVAL	string	Aankomstlocatie.
LOCATION_DEPARTURE	string	Vertreklocatie.
LOCATION_WAYPOINT	string	Way point location.
ROAD_CHANGE	string	Wegwijziging.
TURN	string	Draaien.

GuidanceManeuver

Een code die de manoeuvre identificeert.

Name	Type	Description
ARRIVE	string	Je bent aangekomen.
ARRIVE_LEFT	string	Je bent aangekomen. Uw bestemming bevindt zich aan de linkerkant.
ARRIVE_RIGHT	string	Je bent aangekomen. Uw bestemming bevindt zich aan de rechterkant.
BEAR_LEFT	string	Houd de linkerbenedenhoek.
BEAR_RIGHT	string	Hou je recht.
DEPART	string	Verlaten.
ENTER_FREEWAY	string	Neem de snelweg.
ENTER_HIGHWAY	string	Neem de snelweg.
ENTER_MOTORWAY	string	Neem de snelweg.
ENTRANCE_RAMP	string	Neem de helling.
FOLLOW	string	Volgen.
KEEP_LEFT	string	Blijf links.
KEEP_RIGHT	string	Ga naar rechts.
MAKE_UTURN	string	Maak een U-turn.
MOTORWAY_EXIT_LEFT	string	Neem de linkeruitgang.
MOTORWAY_EXIT_RIGHT	string	Neem de rechteruitgang.
ROUNDABOUT_BACK	string	Ga rond de rotonde.
ROUNDABOUT_CROSS	string	Steek de rotonde over.
ROUNDABOUT_LEFT	string	Bij de rotonde neemt u de afslag aan de linkerkant.
ROUNDABOUT_RIGHT	string	Bij de rotonde neemt u de afslag aan de rechterkant.
SHARP_LEFT	string	Draai scherp naar links.
SHARP_RIGHT	string	Draai scherp rechts.
STRAIGHT	string	Blijf rechtdoor.
SWITCH_MAIN_ROAD	string	Ga naar de hoofdweg.
SWITCH_PARALLEL_ROAD	string	Schakel over naar de parallelle weg.
TAKE_EXIT	string	Neem de uitgang.
TAKE_FERRY	string	Neem de veerboot.
TRY_MAKE_UTURN	string	Probeer een U-turn te maken.
TURN_LEFT	string	Ga linksaf.
TURN_RIGHT	string	Ga naar rechts.
WAYPOINT_LEFT	string	U hebt het waypoint bereikt. Het is aan de linkerkant.
WAYPOINT_REACHED	string	U hebt het waypoint bereikt.
WAYPOINT_RIGHT	string	U hebt het waypoint bereikt. Het staat aan de rechterkant.

InclineLevel

Mate van heuveligheid voor spannende route. Deze parameter kan alleen worden gebruikt in combinatie met routeType=spannende.

Name	Type	Description
high	string	hoog
low	string	laag
normal	string	normaal

JunctionType

Het type verbindingspunt waar de manoeuvre plaatsvindt. Voor grotere rotondes worden twee afzonderlijke instructies gegenereerd voor het binnenkomen en verlaten van de rotonde.

Name	Type	Description
BIFURCATION	string	tweesprong
REGULAR	string	regelmatig
ROUNDABOUT	string	rotonde

LatLongPair

Een locatie die wordt weergegeven als een breedtegraad en lengtegraad.

Name	Type	Description
latitude	number	De eigenschap Breedtegraad
longitude	number	Eigenschap Lengtegraad

Report

Hiermee geeft u op welke gegevens moeten worden gerapporteerd voor diagnosedoeleinden. De enige mogelijke waarde is effectiveSettings. Rapporteert de effectieve parameters of gegevens die worden gebruikt bij het aanroepen van de API. In het geval van standaardparameters wordt de standaardwaarde weergegeven wanneer de parameter niet is opgegeven door de aanroeper.

Name	Type	Description
effectiveSettings	string	Rapporteert de effectieve parameters of gegevens die worden gebruikt bij het aanroepen van de API.

ResponseFormat

Gewenste indeling van het antwoord. De waarde kan json- of xml-zijn.

Name	Type	Description
json	string	De Notatie Data Interchange-indeling voor JavaScript-objecten
xml	string	De uitbreidbare opmaaktaal

ResponseSectionType

Sectietypen van het gerapporteerde routeantwoord

Name	Type	Description
CARPOOL	string	Gedeelten van de route waarvoor het gebruik van carpoolbanen (HOV/High Occupancy Vehicle) nodig is.
CAR_TRAIN	string	Secties van de route die auto's of treinen zijn.
COUNTRY	string	Secties die aangeven in welke landen/regio's de route zich bevindt.
FERRY	string	Secties van de route die veerboten zijn.
MOTORWAY	string	Gedeelten van de route die snelwegen zijn.
PEDESTRIAN	string	Gedeelten van de route die alleen geschikt zijn voor voetgangers.
TOLL_ROAD	string	Secties van de route waarvoor een tol moet worden betaald.
TOLL_VIGNETTE	string	Gedeelten van de route waarvoor een tol vignet aanwezig moet zijn.
TRAFFIC	string	Secties van de route die verkeersinformatie bevatten.
TRAVEL_MODE	string	Secties met betrekking tot de aanvraagparameter `travelMode`.
TUNNEL	string	Secties van de route die tunnels zijn.
URBAN	string	Gedeelten van de route die zich in stedelijke gebieden bevinden.

ResponseTravelMode

De reismodus voor de berekende route. De waarde wordt ingesteld op other als de aangevraagde transportmodus niet mogelijk is in deze sectie

Name	Type	Description
bicycle	string	De geretourneerde routes zijn geoptimaliseerd voor fietsen, waaronder het gebruik van fietsbanen.
bus	string	De geretourneerde routes zijn geoptimaliseerd voor bussen, inclusief het gebruik van alleen busbanen. BÈTA-functionaliteit.
car	string	De geretourneerde routes zijn geoptimaliseerd voor auto's.
motorcycle	string	De geretourneerde routes zijn geoptimaliseerd voor motorfietsen. BÈTA-functionaliteit.
other	string	De opgegeven vervoerswijze is niet mogelijk in deze sectie
pedestrian	string	De geretourneerde routes zijn geoptimaliseerd voor voetgangers, waaronder het gebruik van stoeppaden.
taxi	string	De geretourneerde routes zijn geoptimaliseerd voor taxi's. BÈTA-functionaliteit.
truck	string	De geretourneerde routes zijn geoptimaliseerd voor bedrijfsvoertuigen, zoals voor vrachtwagens.
van	string	De geretourneerde routes zijn geoptimaliseerd voor bestelwagens. BÈTA-functionaliteit.

Route

Name	Type	Description
guidance	RouteGuidance	Bevat richtlijnen gerelateerde elementen. Dit veld is alleen aanwezig wanneer er richtlijnen zijn aangevraagd en beschikbaar is.
legs	RouteLeg[]	Matrice Benen
sections	RouteSection[]	Matrix secties
summary	RouteSummary	Samenvattingsobject

RouteAvoidType

Hiermee geeft u iets op dat de routeberekening moet proberen te vermijden bij het bepalen van de route. Kan meerdere keren in één aanvraag worden opgegeven, bijvoorbeeld '&vermijd=snelwegen&vermijden=tollRoads&avoid=veerboten'. In routebereikaanvragen mag de waarde alreadyUsedRoads niet worden gebruikt.

Name	Type	Description
alreadyUsedRoads	string	Vermijd het gebruik van dezelfde weg meerdere keren. Meest nuttig in combinatie met `routeType`=spannende.
borderCrossings	string	Vermijdt grensovergangen in routeberekening.
carpools	string	Vermijd routes die het gebruik van carpoolbanen (HOV/High Occupancy Vehicle) vereisen.
ferries	string	Vermijd veerboten
motorways	string	Vermijdt snelwegen
tollRoads	string	Vermijd tolwegen.
unpavedRoads	string	Vermijdt onverharde wegen

RouteDirections

Dit object wordt geretourneerd door een geslaagde aanroep Routebeschrijving

Name	Type	Description
formatVersion	string	Eigenschap Versie opmaken
optimizedWaypoints	RouteOptimizedWaypoint[]	Geoptimaliseerde volgorde van waypoints. Het toont de index van de door de gebruiker verstrekte waypoint-reeks voor de oorspronkelijke en geoptimaliseerde lijst. Bijvoorbeeld een antwoord: `<optimizedWaypoints> <waypoint providedIndex="0" optimizedIndex="1"/> <waypoint providedIndex="1" optimizedIndex="2"/> <waypoint providedIndex="2" optimizedIndex="0"/> </optimizedWaypoints>` betekent dat de oorspronkelijke reeks [0, 1, 2] en geoptimaliseerde reeks [1, 2, 0] is. Omdat de index begint met 0, is het origineel 'eerste, tweede, derde' terwijl de geoptimaliseerde waarde 'tweede, derde, eerste' is.
report	RouteReport	Rapporteert de effectieve instellingen die worden gebruikt in de huidige aanroep.
routes	Route[]	Matrix routes

RouteGuidance

Bevat richtlijnen gerelateerde elementen. Dit veld is alleen aanwezig wanneer er richtlijnen zijn aangevraagd en beschikbaar is.

Name	Type	Description
instructionGroups	RouteInstructionGroup[]	Hiermee wordt een reeks instructie-elementen gegroepeerd die aan elkaar zijn gerelateerd.
instructions	RouteInstruction[]	Een lijst met instructies voor het beschrijven van manoeuvre.

RouteInstruction

Een reeks kenmerken die een manoeuvre beschrijven, bijvoorbeeld 'Rechts rechts', 'Links blijven', 'Neem de veerboot', 'Neem de snelweg', 'Arrive'.

Name	Type	Description
combinedMessage	string	Een mensleesbaar bericht voor de manoeuvre in combinatie met het bericht uit de volgende instructie. Soms is het mogelijk om twee opeenvolgende instructies te combineren tot één instructie, waardoor het gemakkelijker te volgen is. Als dit het geval is, is de vlag possibleCombineWithNext waar. Bijvoorbeeld: `10. Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam 11. Follow Einsteinweg/A10/E22 towards Ring Amsterdam` De mogelijke VlagCombineWithNext op instructie 10 is waar. Dit geeft aan de clients van gecodeerde richtlijnen aan dat deze kan worden gecombineerd met instructie 11. De instructies worden automatisch gecombineerd voor klanten die door mensen leesbare richtlijnen aanvragen. Het veld combinedMessage bevat het gecombineerde bericht: `Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam then follow Einsteinweg/A10/E22 towards Ring Amsterdam.`
countryCode	string	3 tekens ISO 3166-1 alfa-3 landcode. Bijvoorbeeld VS.
drivingSide	DrivingSide	Geeft links-vs. rechts rijden aan op het punt van de manoeuvreer.
exitNumber	string	Het aantal(en) van een snelweguitgang die door de huidige manoeuvre wordt genomen. Als een uitgang meerdere afsluitnummers heeft, worden deze gescheiden door ',' en mogelijk samengevoegd door '-', bijvoorbeeld '10, 13-15'.
instructionType	GuidanceInstructionType	Type instructie, bijvoorbeeld omdraaien of wijzigen van wegformulier.
junctionType	JunctionType	Het type verbindingspunt waar de manoeuvre plaatsvindt. Voor grotere rotondes worden twee afzonderlijke instructies gegenereerd voor het binnenkomen en verlaten van de rotonde.
maneuver	GuidanceManeuver	Een code die de manoeuvre identificeert.
message	string	Een mensleesbaar bericht voor de manoeuvre.
point	LatLongPair	Een locatie die wordt weergegeven als een breedtegraad en lengtegraad.
pointIndex	integer	De index van het punt in de lijst met polylijnpunten die overeenkomen met het punt van de instructie.
possibleCombineWithNext	boolean	Het is mogelijk om eventueel de instructie te combineren met de volgende. Dit kan worden gebruikt om berichten te maken, zoals 'Links en vervolgens naar rechts'.
roadNumbers	string[]	Het wegnummer(en) van de volgende belangrijke wegsegment(en) na de manoeuvre of van de weg(en) die moeten worden gevolgd. Voorbeeld: ["E34", "N205"]
roundaboutExitNumber	integer	Dit geeft aan welke uitgang bij een rotonde moet worden uitgevoerd.
routeOffsetInMeters	integer	Afstand van het begin van de route naar het punt van de instructie.
signpostText	string	De tekst op een wegwijzer die het meest relevant is voor de manoeuvre of de richting die moet worden gevolgd.
stateCode	string	Een onderverdeling (bijvoorbeeld staat) van het land, vertegenwoordigd door het tweede deel van een ISO 3166-2 code. Dit is alleen beschikbaar voor sommige landen/regio's, zoals de VS, Canada en Mexico.
street	string	Straatnaam van het volgende significante wegsegment na de manoeuvre of van de straat die moet worden gevolgd.
travelTimeInSeconds	integer	Geschatte reistijd tot het punt dat overeenkomt met routeOffsetInMeters.
turnAngleInDecimalDegrees	integer	Geeft de richting van een instructie aan. Als junctionType een draaiinstructie aangeeft: 180 = U-draai [-179, -1] = Links 0 = Recht aan (een '0 graden' draai) [1, 179] = Rechts Als junctionType een bifurcation-instructie aangeeft: <0 - links houden >0 - rechts houden

RouteInstructionGroup

Hiermee wordt een reeks instructie-elementen gegroepeerd die aan elkaar zijn gerelateerd. Het reeksbereik is beperkt met firstInstructionIndex en lastInstructionIndex. Wanneer door mensen leesbare tekstberichten worden aangevraagd voor richtlijnen (instructionType=text of gelabeld), heeft de instructionGroup een samenvattingsbericht geretourneerd wanneer deze beschikbaar is.

Name	Type	Description
firstInstructionIndex	integer	Index van de eerste instructie in de instructies en behoren tot deze groep.
groupLengthInMeters	integer	De lengte van de groep.
groupMessage	string	Samenvattingsbericht wanneer door mensen leesbare tekstberichten worden aangevraagd voor richtlijnen (instructionType=text of gelabeld).
lastInstructionIndex	integer	Index van de laatste instructie in de instructies en behoren tot deze groep.

RouteInstructionsType

Indien opgegeven, worden instructies geretourneerd. Houd er rekening mee dat de parameter instructionsType niet kan worden gebruikt in combinatie met routeRepresentation=none.

Name Type Description

coded

Name	Type	Description
coded	string	Retourneert onbewerkte instructiegegevens zonder door mensen leesbare berichten.
tagged	string	Retourneert onbewerkte instructiegegevens met getagde berichten die door mensen kunnen worden gelezen om opmaak mogelijk te maken. Een door mensen leesbaar bericht is opgebouwd uit herhaalbare geïdentificeerde elementen. Deze worden getagd om clienttoepassingen toe te staan ze correct te formatteren. De volgende berichtonderdelen worden getagd wanneer instructionsType=tagged: street, roadNumber, signpostText, exitNumber, rotondeExitNumber. Voorbeeld van het gemarkeerde bericht 'Linksaf draaien': `Turn left onto <roadNumber>A4</roadNumber>/<roadNumber>E19</roadNumber> towards <signpostText>Den Haag</signpostText>`
text	string	Retourneert onbewerkte instructies met door mensen leesbare berichten in tekst zonder opmaak.

string

Retourneert onbewerkte instructiegegevens zonder door mensen leesbare berichten.

tagged

string

Retourneert onbewerkte instructiegegevens met getagde berichten die door mensen kunnen worden gelezen om opmaak mogelijk te maken. Een door mensen leesbaar bericht is opgebouwd uit herhaalbare geïdentificeerde elementen. Deze worden getagd om clienttoepassingen toe te staan ze correct te formatteren. De volgende berichtonderdelen worden getagd wanneer instructionsType=tagged: street, roadNumber, signpostText, exitNumber, rotondeExitNumber.

Voorbeeld van het gemarkeerde bericht 'Linksaf draaien':

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

text

string

Retourneert onbewerkte instructies met door mensen leesbare berichten in tekst zonder opmaak.

RouteLeg

Een beschrijving van een deel van een route, bestaande uit een lijst met punten. Elk extra waypoint dat in de aanvraag wordt opgegeven, resulteert in een extra been in de geretourneerde route.

Name	Type	Description
points	LatLongPair[]	Puntenmatrix
summary	RouteLegSummary	Overzichtsobject voor routesectie.

RouteLegSummary

Overzichtsobject voor routesectie.

Name	Type	Description
arrivalTime	string	De geschatte aankomsttijd voor de route of het been. De tijd is in UTC.
batteryConsumptionInkWh	number	Geschat energieverbruik in kilowatturen (kWh) met behulp van het elektrische verbruiksmodel. Inbegrepen als vehicleEngineType is ingesteld op elektrische en constantSpeedConsumptionInkWhPerHundredkm is opgegeven. De waarde van batteryConsumptionInkWh omvat de gerecupereerde elektrische energie en kan daarom negatief zijn (wat aangeeft dat energie wordt gewonnen). Als zowel maxChargeInkWh als currentChargeInkWh zijn opgegeven, wordt de recuperatie beperkt om ervoor te zorgen dat het oplaadniveau van de batterij nooit hoger is dan maxChargeInkWh. Als maxChargeInkWh of currentChargeInkWh niet zijn opgegeven, wordt niet-getrainde recuperatie verondersteld in de verbruiksberekening.
departureTime	string	De geschatte vertrektijd voor de route of het been. De tijd is in UTC.
fuelConsumptionInLiters	number	Geschat brandstofverbruik in liter met behulp van het verbrandingsverbruiksmodel. Inbegrepen als vehicleEngineType is ingesteld op verbranding en constantSpeedConsumptionInLitersPerHundredkm is opgegeven. De waarde is niet-negatief.
historicTrafficTravelTimeInSeconds	integer	Geschatte reistijd berekend met tijdafhankelijke historische verkeersgegevens. Alleen opgenomen als computeTravelTimeFor = alles wordt gebruikt in de query.
lengthInMeters	integer	Eigenschap Length In Meters
liveTrafficIncidentsTravelTimeInSeconds	integer	Geschatte reistijd berekend met realtime snelheidsgegevens. Alleen opgenomen als computeTravelTimeFor = alles wordt gebruikt in de query.
noTrafficTravelTimeInSeconds	integer	Geschatte reistijd berekend alsof er geen vertragingen op de route zijn vanwege verkeersomstandigheden (bijvoorbeeld congestie). Alleen opgenomen als computeTravelTimeFor = alles wordt gebruikt in de query.
trafficDelayInSeconds	integer	Geschatte vertraging in seconden veroorzaakt door het realtime incident(en) op basis van verkeersinformatie. Voor routes gepland met vertrektijd in de toekomst is vertragingen altijd 0. Als u extra reistijden wilt retourneren met behulp van verschillende typen verkeersinformatie, moet u parameter computeTravelTimeFor=all toevoegen.
travelTimeInSeconds	integer	Geschatte reistijd in seconden eigenschap met de vertraging als gevolg van realtime verkeer. Houd er rekening mee dat zelfs wanneer verkeer=false travelTimeInSeconds de vertraging als gevolg van verkeer nog steeds bevat. Als DepartAt zich in de toekomst bevindt, wordt reistijd berekend met tijdafhankelijke historische verkeersgegevens.

RouteOptimizedWaypoint

Geoptimaliseerd way point-object.

Name	Type	Description
optimizedIndex	integer	Geoptimaliseerde way point index van het systeem.
providedIndex	integer	Way point index geleverd door de gebruiker.

RouteReport

Rapporteert de effectieve instellingen die worden gebruikt in de huidige aanroep.

Name	Type	Description
effectiveSettings	EffectiveSetting[]	Effectieve parameters of gegevens die worden gebruikt bij het aanroepen van deze Route-API.

RouteRepresentationForBestOrder

Hiermee geeft u de weergave van de set routes opgegeven als antwoord.

Name	Type	Description
none	string	Bevat alleen de geoptimaliseerde waypoint-indexen, maar bevat niet de routegeometrie in het antwoord. Deze parameterwaarde kan alleen worden gebruikt in combinatie met computeBestOrder=true.
polyline	string	Bevat routegeometrie in het antwoord.
summaryOnly	string	Samenvatting per polylijn, maar exclusief de puntgeometrie-elementen voor de routes in het antwoord.

RouteSection

Routesecties bevatten aanvullende informatie over onderdelen van een route. Elke sectie bevat ten minste de elementen startPointIndex, endPointIndexen sectionType.

Name	Type	Description
delayInSeconds	integer	Vertraging in seconden veroorzaakt door het incident.
effectiveSpeedInKmh	integer	Effectieve snelheid van het incident in km/h, gemiddeld over de gehele lengte.
endPointIndex	integer	Index van het laatste punt (offset 0) in de route waarop deze sectie van toepassing is.
magnitudeOfDelay	DelayMagnitude	De omvang van de vertraging die wordt veroorzaakt door het incident. Deze waarden komen overeen met de waarden van het antwoordveld van de Traffic Incident Detail APIophalen.
sectionType	ResponseSectionType	Sectietypen van het gerapporteerde routeantwoord
simpleCategory	SimpleCategory	Type van het incident. Kan momenteel JAM, ROAD_WORK, ROAD_CLOSURE of OTHER zijn. Zie "tec" voor gedetailleerde informatie.
startPointIndex	integer	Index van het eerste punt (offset 0) in de route waar deze sectie op van toepassing is.
tec	RouteSectionTec	Details van de verkeersgebeurtenis met behulp van definities in de TPEG2-TEC standaard. Kan effectCode bevatten en elementen veroorzaken.
travelMode	ResponseTravelMode	De reismodus voor de berekende route. De waarde wordt ingesteld op `other` als de aangevraagde transportmodus niet mogelijk is in deze sectie

RouteSectionTec

Details van de verkeersgebeurtenis met behulp van definities in de TPEG2-TEC standaard. Kan effectCode bevatten en elementen veroorzaken.

Name	Type	Description
causes	RouteSectionTecCause[]	Oorzaken van matrix
effectCode	integer	Het effect op de verkeersstroom. Bevat een waarde in de tabel tec001:EffectCode, zoals gedefinieerd in de standaard TPEG2-TEC. Kan worden gebruikt om verkeersgebeurtenissen in kleur te coden op basis van de ernst.

RouteSectionTecCause

De oorzaak van de verkeers gebeurtenis. Kan mainCauseCode- en subCauseCode-elementen bevatten. Kan worden gebruikt om iconografie en beschrijvingen te definiëren.

Name	Type	Description
mainCauseCode	integer	De belangrijkste oorzaak van de verkeers gebeurtenis. Bevat een waarde in de tec002:CauseCode-tabel, zoals gedefinieerd in de standaard TPEG2-TEC.
subCauseCode	integer	De subcause van de verkeers gebeurtenis. Bevat een waarde in de suboorzaaktabel die is gedefinieerd door de mainCauseCode, zoals gedefinieerd in de standaard TPEG2-TEC.

RouteSummary

Samenvattingsobject

Name	Type	Description
arrivalTime	string	De geschatte aankomsttijd voor de route of het been. De tijd is in UTC.
departureTime	string	De geschatte vertrektijd voor de route of het been. De tijd is in UTC.
lengthInMeters	integer	Eigenschap Length In Meters
trafficDelayInSeconds	integer	Geschatte vertraging in seconden veroorzaakt door het realtime incident(en) op basis van verkeersinformatie. Voor routes gepland met vertrektijd in de toekomst is vertragingen altijd 0. Als u extra reistijden wilt retourneren met behulp van verschillende typen verkeersinformatie, moet u parameter computeTravelTimeFor=all toevoegen.
travelTimeInSeconds	integer	Geschatte reistijd in seconden eigenschap met de vertraging als gevolg van realtime verkeer. Houd er rekening mee dat zelfs wanneer verkeer=false travelTimeInSeconds de vertraging als gevolg van verkeer nog steeds bevat. Als DepartAt zich in de toekomst bevindt, wordt reistijd berekend met tijdafhankelijke historische verkeersgegevens.

RouteType

Het type route aangevraagd.

Name	Type	Description
eco	string	Een route die in balans is met economie en snelheid.
fastest	string	De snelste route.
shortest	string	De kortste route op afstand.
thrilling	string	Omvat interessante of uitdagende wegen en maakt gebruik van zo weinig mogelijk snelwegen. U kunt kiezen hoeveel bochten er zijn inbegrepen en ook de mate van heuvelachtigheid. Bekijk de heuvelachtige en wikkelingsparameters voor hoe u dit instelt. Er is een limiet van 900 km op routes gepland met `routeType`=spannende

SectionType

Hiermee geeft u op welke sectietypen worden gerapporteerd in het routeantwoord.

Als bijvoorbeeld sectionType = voetgangers de secties die alleen geschikt zijn voor voetgangers, worden geretourneerd. Kan meerdere keren worden opgegeven in één aanvraag, bijvoorbeeld '§ionType=carTrain§ionType=voetgangers§ionType=snelweg'. Het standaard sectionType verwijst naar de travelMode-invoer. Standaard is travelMode ingesteld op auto

Name	Type	Description
carTrain	string	Secties van de route die auto's of treinen zijn.
carpool	string	Gedeelten van de route waarvoor het gebruik van carpoolbanen (HOV/High Occupancy Vehicle) nodig is.
country	string	Secties die aangeven in welke landen/regio's de route zich bevindt.
ferry	string	Secties van de route die veerboten zijn.
motorway	string	Gedeelten van de route die snelwegen zijn.
pedestrian	string	Gedeelten van de route die alleen geschikt zijn voor voetgangers.
tollRoad	string	Secties van de route waarvoor een tol moet worden betaald.
tollVignette	string	Gedeelten van de route waarvoor een tol vignet aanwezig moet zijn.
traffic	string	Secties van de route die verkeersinformatie bevatten.
travelMode	string	Secties met betrekking tot de aanvraagparameter `travelMode`.
tunnel	string	Secties van de route die tunnels zijn.
urban	string	Gedeelten van de route die zich in stedelijke gebieden bevinden.

SimpleCategory

Type van het incident. Kan momenteel JAM, ROAD_WORK, ROAD_CLOSURE of OTHER zijn. Zie "tec" voor gedetailleerde informatie.

Name	Type	Description
JAM	string	File.
OTHER	string	Ander.
ROAD_CLOSURE	string	Wegsluiting.
ROAD_WORK	string	Wegwerk.

TravelMode

De reismodus voor de aangevraagde route. Als dit niet is gedefinieerd, is de standaardwaarde 'auto'. Houd er rekening mee dat de aangevraagde travelMode mogelijk niet beschikbaar is voor de hele route. Wanneer de aangevraagde travelMode niet beschikbaar is voor een bepaalde sectie, is het element travelMode van het antwoord voor die sectie 'overig'. Houd er rekening mee dat reismodi bus, motorfiets, taxi en busje beta-functionaliteit zijn. Volledige beperkingsgegevens zijn niet beschikbaar in alle gebieden.

Name	Type	Description
bicycle	string	De geretourneerde routes zijn geoptimaliseerd voor fietsen, waaronder het gebruik van fietsbanen.
bus	string	De geretourneerde routes zijn geoptimaliseerd voor bussen, inclusief het gebruik van alleen busbanen. BÈTA-functionaliteit.
car	string	De geretourneerde routes zijn geoptimaliseerd voor auto's.
motorcycle	string	De geretourneerde routes zijn geoptimaliseerd voor motorfietsen. BÈTA-functionaliteit.
pedestrian	string	De geretourneerde routes zijn geoptimaliseerd voor voetgangers, waaronder het gebruik van stoeppaden.
taxi	string	De geretourneerde routes zijn geoptimaliseerd voor taxi's. BÈTA-functionaliteit.
truck	string	De geretourneerde routes zijn geoptimaliseerd voor bedrijfsvoertuigen, zoals voor vrachtwagens.
van	string	De geretourneerde routes zijn geoptimaliseerd voor bestelwagens. BÈTA-functionaliteit.

VehicleEngineType

Motortype van het voertuig. Wanneer een gedetailleerd verbruiksmodel is opgegeven, moet het consistent zijn met de waarde van vehicleEngineType.

Name	Type	Description
combustion	string	Interne verbrandingsmotor.
electric	string	Elektrische motor.

VehicleLoadType

Soorten ladingen die kunnen worden geclassificeerd als gevaarlijke materialen en beperkt zijn van sommige wegen. Beschikbare vehicleLoadType-waarden zijn US Hazmat-klassen 1 tot en met 9, plus algemene classificaties voor gebruik in andere landen/regio's. Waarden die beginnen met USHazmat zijn voor amerikaanse routering, terwijl andereHazmat moet worden gebruikt voor alle andere landen/regio's. vehicleLoadType kan meerdere keren worden opgegeven. Deze parameter wordt momenteel alleen in aanmerking genomen voor travelMode=truck.

Name	Type	Description
USHazmatClass1	string	Explosieven
USHazmatClass2	string	Gecomprimeerd gas
USHazmatClass3	string	Brandbare vloeistoffen
USHazmatClass4	string	Brandbare vaste stoffen
USHazmatClass5	string	Oxidizers
USHazmatClass6	string	Vergif
USHazmatClass7	string	Radioactief
USHazmatClass8	string	Corrosieven
USHazmatClass9	string	Allerlei
otherHazmatExplosive	string	Explosieven
otherHazmatGeneral	string	Allerlei
otherHazmatHarmfulToWater	string	Schadelijk voor water

WindingnessLevel

Hoogte van bochten voor spannende route. Deze parameter kan alleen worden gebruikt in combinatie met routeType=spannende.

Name	Type	Description
high	string	hoog
low	string	laag
normal	string	normaal

Delen via

Route - Get Route Directions

URI-parameters

Aanvraagkoptekst

Antwoorden

Beveiliging

AADToken

Notities

Bereiken

subscription-key

SAS Token

Voorbeelden

Successfully retrieve a route between an origin and a destination

Voorbeeldaanvraag

Voorbeeldrespons

Definities

AlternativeRouteType

ComputeTravelTime

DelayMagnitude

DrivingSide

EffectiveSetting

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GuidanceInstructionType

GuidanceManeuver

InclineLevel

JunctionType

LatLongPair

Report

ResponseFormat

ResponseSectionType

ResponseTravelMode

Route

RouteAvoidType

RouteDirections

RouteGuidance

RouteInstruction

RouteInstructionGroup

RouteInstructionsType

RouteLeg

RouteLegSummary

RouteOptimizedWaypoint

RouteReport

RouteRepresentationForBestOrder

RouteSection

RouteSectionTec

RouteSectionTecCause

RouteSummary

RouteType

SectionType

SimpleCategory

TravelMode

VehicleEngineType

VehicleLoadType

WindingnessLevel

Aanvullende resources