Route - Get Route Directions

Service:

Maps

API Version:

1.0

Gebruik om een route te berekenen tussen een opgegeven oorsprong en bestemming, waarbij eventuele opgegeven waypoints worden doorgegeven.

De Get Route Directions API is een HTTP-aanvraag GET die een route retourneert tussen een oorsprong en een bestemming, waarbij via waypoints wordt opgegeven. De route houdt rekening met factoren zoals het huidige verkeer en de typische wegsnelheden 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. Afhankelijk van de geselecteerde opties zijn ook aanvullende routeringsinformatie beschikbaar, zoals geoptimaliseerde volgorde van waypoint of turn by turn.

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

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

With optional 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 de laatste is de bestemming van de route. Optionele coördinaten tussenin fungeren als WayPoints in de route. U kunt maximaal 150 WayPoints doorgeven.
accelerationEfficiency	query		number double	Hiermee wordt de efficiëntie aangegeven van het omzetten van chemische energie die in brandstof is opgeslagen in kinetische energie wanneer het voertuig accelereert (dat wil zeggen KineticEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed wordt verkregen door het omzetten van verbruikte brandstof in chemische energie met behulp van fuelEnergyDensityInMJoulesPerLiter. Moet worden gekoppeld aan decelerationEfficiency. Het toegestane bereik van waarden is 0,0 tot 1/decelerationEfficiency. Zinnige waarden : voor verbrandingsmodel : 0.33, voor elektrisch model : 0.66
alternativeType	query		AlternativeRouteType	Bepaalt de optimalisatie, met betrekking tot de gegeven planningscriteria, van de berekende alternatieven ten opzichte van de referentieroute.
arriveAt	query		string date-time	De datum en tijd van aankomst op het bestemmingspunt opgemaakt als een dateTime waarde zoals gedefinieerd in RFC 3339, sectie 5.6, met een optionele tijdzone-verschuiving. Wanneer er geen tijdzoneverschil wordt opgegeven, wordt ervan uitgegaan dat deze die van het doelpunt is. Voorbeelden: 2023-12-19T16:39:57 2023-12-20T00:39:57+00:00 De arriveAt parameter 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 kilowatt (kW). Het kan worden gebruikt om verbruik te specificeren 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 het onderhouden van hulpsystemen van het voertuig, in liter per uur. Het kan worden gebruikt om verbruik te specificeren 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 '&avoid=motorways&avoid=tollRoads&avoid=ferries'. In Aanvragen voor routebereik mag de waarde alreadyUsedRoads niet worden gebruikt.
computeBestOrder	query		boolean	De routeroutepunten opnieuw ordenen met behulp van een snel heuristisch algoritme om de lengte van de route te verminderen. Levert de beste resultaten op wanneer deze wordt gebruikt in combinatie met routeType shortest. U ziet dat oorsprong en bestemming zijn 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 het doel toe als de uiteindelijke index. Mogelijke waarden zijn true of false. Waar berekent indien mogelijk een betere volgorde, maar mag niet worden gebruikt in combinatie met maxAlternatives-waarde groter dan 0 of in combinatie met cirkelwegpunten. False gebruikt de locaties in de opgegeven volgorde en mogen niet worden gebruikt in combinatie met routeRepresentation none.
computeTravelTimeFor	query		ComputeTravelTime	Hiermee geeft u op of extra reistijden moeten worden geretourneerd met behulp van verschillende typen verkeersinformatie (geen, historisch, live) en de standaard best geschatte reistijd.
constantSpeedConsumptionInkWhPerHundredkm	query		string	Hiermee geeft u de snelheidsafhankelijke component van het verbruik. Opgegeven als een niet-geordende lijst met snelheids-verbruikstariefparen. De lijst definieert punten op een verbruikscurve. Verbruikstarieven voor snelheden die niet in de lijst staan, zijn als volgt te vinden: door lineaire interpolatie, indien de opgegeven snelheid tussen twee snelheden in de lijst ligt anders door lineaire extrapolatie, 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 gebruikt zonder verdere verwerking. Het opgegeven verbruik voor de hoogste snelheid moet groter zijn dan of gelijk zijn aan dat van de voorlaatste hoogste snelheid. Dit zorgt ervoor dat extrapolatie niet leidt tot negatieve consumptiepercentages. Op dezelfde manier kunnen verbruikswaarden die zijn opgegeven voor de twee kleinste snelheden in de lijst, niet leiden tot een negatief verbruik voor een lagere snelheid. Het geldige bereik voor de verbruikswaarden (uitgedrukt in kWh/100km) ligt tussen 0,01 en 100000,0. Zinnige waarden : 50,8.2:130,21,3 Deze parameter is vereist voor het model Voor elektrisch verbruik.
constantSpeedConsumptionInLitersPerHundredkm	query		string	Hiermee geeft u de snelheidsafhankelijke component van het verbruik. Wordt geleverd als een ongeordeerde lijst met door dubbele punt gescheiden snelheids-& verbruikstariefparen. De lijst definieert punten op een verbruikscurve. Verbruikstarieven voor snelheden die niet in de lijst staan, zijn als volgt te vinden: door lineaire interpolatie, indien de opgegeven snelheid tussen twee snelheden in de lijst ligt anders door lineaire extrapolatie, 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 gebruikt zonder verdere verwerking. Het opgegeven verbruik voor de hoogste snelheid moet groter zijn dan of gelijk zijn aan dat van de voorlaatste hoogste snelheid. Dit zorgt ervoor dat extrapolatie niet leidt tot negatieve consumptiepercentages. Op dezelfde manier kunnen verbruikswaarden die zijn opgegeven voor de twee kleinste snelheden in de lijst, niet leiden tot een negatief verbruik voor een lagere snelheid. Het geldige bereik voor de verbruikswaarden (uitgedrukt in l/100km) ligt tussen 0,01 en 100000,0. Zinnige 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 energievoorziening in kilowattuur (kWh) op. Deze parameter bestaat naast de parameter maxChargeInkWh . Het toegestane waardenbereik is 0,0 tot maxChargeInkWh. Zinnige waarden : 43
currentFuelInLiters	query		number double	Hiermee geeft u de huidige brandstoftoevoer in liter aan. Zinnige waarden: 55
decelerationEfficiency	query		number double	Specificeert de efficiëntie van het omzetten van kinetische energie in opgeslagen (niet verbruikte) brandstof wanneer het voertuig vertraagt (d.w.w.v. ChemicalEnergySaved/KineticEnergyLost). ChemicalEnergySaved wordt verkregen door het omzetten van opgeslagen (niet verbruikte) brandstof naar energie met behulp van fuelEnergyDensityInMJoulesPerLiter. Moet worden gekoppeld aan accelerationEfficiency. Het toegestane bereik van waarden is 0,0 tot 1/accelerationEfficiency. Zinnige waarden : voor verbrandingsmodel : 0.83, voor elektrisch model : 0.91
departAt	query		string date-time	De datum en tijd van vertrek vanaf het beginpunt opgemaakt als een dateTime waarde zoals gedefinieerd in RFC 3339, sectie 5.6, met een optionele tijdzone-offset. Wanneer er geen tijdzoneverschil is opgegeven, wordt ervan uitgegaan dat deze de verschuiving van het beginpunt is. Standaardwaarde: nu Andere waarde: dateTime Voorbeelden: 2023-12-19T16:39:57 2023-12-20T00:39:57+00:00 De departAt parameter kan niet worden gebruikt in combinatie met arriveAt.
downhillEfficiency	query		number double	Hiermee geeft u de efficiëntie van het omzetten van potentiële energie in opgeslagen (niet verbruikte) brandstof wanneer het voertuig hoogte verliest (d.w.w. ChemicalEnergySaved/PotentialEnergyLost). ChemicalEnergySaved wordt verkregen door het omzetten van opgeslagen (niet verbruikte) brandstof naar energie met behulp van fuelEnergyDensityInMJoulesPerLiter. Moet worden gekoppeld aan uphillEfficiency. Het toegestane bereik van waarden is 0,0 tot 1/uphillEfficiency. Zinnige 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 *Efficiëntieparameters voor conversies tussen bespaarde of verbruikte energie en brandstof. De 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. Zinnige waarden: 34.2
hilliness	query		InclineLevel	Mate van heuvelachtigheid voor spannende route. Deze parameter kan alleen worden gebruikt in combinatie met routeType=thrilling.
instructionsType	query		RouteInstructionsType	Indien opgegeven, worden richtlijnen 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 hulpberichten. Zelfstandige naamwoorden (de namen van straten, pleinen, enz.) worden geretourneerd in de opgegeven taal, of als dat niet beschikbaar is, worden ze geretourneerd in een beschikbare taal die er dichtbij is. 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 kilowattuur (kWh) op die in de accu van het voertuig mag worden opgeslagen. Deze parameter bestaat naast de parameter currentChargeInkWh . De minimumwaarde moet groter zijn dan of gelijk zijn aan currentChargeInkWh. Zinnige waarden : 85
minDeviationDistance	query		integer	Alle alternatieve routes die worden geretourneerd, volgen de referentieroute (zie sectie POST-aanvragen) vanaf het beginpunt 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 beginpunt 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. Het instellen van )minDeviationTime_ op een waarde groter dan nul heeft de volgende gevolgen: Het beginpunt van de calculateRoute-aanvraag moet zich op (of zeer dicht bij) de invoerreferentieroute bevindt. Als dit niet het geval is, wordt er een fout geretourneerd. Het beginpunt hoeft echter niet aan het begin van de invoerreferentieroute te staan (het kan worden beschouwd als de huidige positie van het voertuig op de referentieroute). De referentieroute, die wordt geretourneerd als de eerste route in het calculateRoute-antwoord , begint bij het beginpunt dat is opgegeven in de calculateRoute-aanvraag . Het eerste deel van de invoerreferentieroute tot het beginpunt wordt uitgesloten van het antwoord. De waarden van minDeviationDistance en minDeviationTime bepalen hoe ver alternatieve routes gegarandeerd de referentieroute volgen vanaf het beginpunt. De route moet departAt gebruiken. Het voertuigHeading 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. Deze parameterwaarde kan alleen worden gebruikt in combinatie met computeBestOrder=true.
routeType	query		RouteType	Het type route dat is aangevraagd.
sectionType	query		SectionType	Hiermee geeft u op welke van de sectietypen wordt gerapporteerd in het antwoord van de route. Bijvoorbeeld als sectionType = voetganger de secties die alleen geschikt zijn voor voetgangers worden geretourneerd. Er kunnen meerdere typen worden gebruikt. Het standaard sectionType verwijst naar de travelMode-invoer. TravelMode is standaard ingesteld op auto
traffic	query		boolean	Mogelijke waarden: true - Houd rekening met alle beschikbare verkeersinformatie tijdens het routeren false: huidige verkeersgegevens negeren tijdens routering. Houd er rekening mee dat hoewel de huidige verkeersgegevens tijdens het routeren worden genegeerd, het effect van historisch verkeer op effectieve snelheden op de weg nog steeds wordt meegenomen.
travelMode	query		TravelMode	De manier van reizen 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. Als de aangevraagde travelMode niet beschikbaar is voor een bepaalde sectie, is het travelMode-element van het antwoord voor die sectie 'overige'. Houd er rekening mee dat reismodi bus, motor, taxi en busje beta-functionaliteit zijn. Volledige beperkingsgegevens zijn niet in alle gebieden beschikbaar.
uphillEfficiency	query		number double	Hiermee geeft u de efficiëntie op van het omzetten van chemische energie die in brandstof is opgeslagen in potentiële energie wanneer het voertuig hoger wordt (dat wil zeggen PotentialEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed wordt verkregen door het omzetten van verbruikte brandstof in chemische energie met behulp van fuelEnergyDensityInMJoulesPerLiter. Moet worden gekoppeld aan downhillEfficiency. Het toegestane bereik van waarden 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 in aanmerking worden genomen.
vehicleCommercial	query		boolean	Of het voertuig wordt gebruikt voor commerciële doeleinden. Op sommige wegen mogen bedrijfsvoertuigen mogelijk niet rijden.
vehicleEngineType	query		VehicleEngineType	Motortype van het voertuig. Wanneer een gedetailleerd verbruiksmodel wordt opgegeven, moet dit consistent zijn met de waarde van vehicleEngineType.
vehicleHeading	query		integer	De richtingsrichting van het voertuig in graden beginnend bij het ware noorden en doorgaand in rechtsom. Noord is 0 graden, oost is 90 graden, zuid 180 graden, west 270 graden. Mogelijke waarden 0-359
vehicleHeight	query		number double	Hoogte van het voertuig in meters. De waarde 0 betekent dat hoogtebeperkingen niet in aanmerking worden genomen.
vehicleLength	query		number double	Lengte van het voertuig in meters. Een waarde van 0 betekent dat er geen rekening wordt gehouden met lengtebeperkingen.
vehicleLoadType	query		VehicleLoadType	Soorten ladingen die kunnen worden geclassificeerd als gevaarlijke materialen en beperkt zijn vanaf bepaalde wegen. Beschikbare vehicleLoadType-waarden zijn Amerikaanse 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 otherHazmat 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 maximumsnelheid in het voertuigprofiel wordt gebruikt om te controleren of een voertuig op snelwegen is toegestaan. Een waarde van 0 betekent dat een geschikte waarde voor het voertuig wordt bepaald en toegepast tijdens de routeplanning. Een niet-nulwaarde kan worden overschreven tijdens het plannen van de route. 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 80 km/uur bedraagt, maar de huidige verkeersstroom 60 km/uur is, gebruikt de routeringsmotor opnieuw 60 km/uur.
vehicleWeight	query		integer	Gewicht van het voertuig in kilogrammen. 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 gedetailleerd verbruiksmodel is opgegeven en de waarde van vehicleWeight niet nul is, worden gewichtsbeperkingen overwogen. In alle andere gevallen wordt deze parameter genegeerd. Zinnige 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 in aanmerking worden genomen.
windingness	query		WindingnessLevel	Niveau van bochten voor spannende route. Deze parameter kan alleen worden gebruikt in combinatie met routeType=thrilling.

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 Azure Maps beheervlak Account-API. Als u Microsoft Entra ID beveiliging wilt gebruiken in Azure Maps raadpleegt u de volgende artikelen voor hulp.

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-stromen. Wanneer het 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 tot een of meer Azure Maps resourceaccount of subresources aan te wijzen. 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 verificatieconcepten te bekijken. Samengevat biedt deze beveiligingsdefinitie een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen hebben voor specifieke API's en bereiken.

Notities

• Voor deze beveiligingsdefinitie is het gebruik van de x-ms-client-id header vereist om aan te geven tot welke Azure Maps resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Kaarten-beheer-API.

De Authorization URL is specifiek voor het azure-exemplaar van de openbare cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Microsoft Entra ID configuraties. * Op rollen gebaseerd 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 configuratie van een toepassing mogelijk voor meerdere gebruiksvoorbeelden.

• Zie overzicht van Microsoft identity platform voor meer informatie over Microsoft identity platform.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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 Creatie in de 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 zijn uitgegeven.

Voor openbaar beschikbare toepassingen wordt aanbevolen om de benadering van vertrouwelijke clienttoepassingen te gebruiken 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 is gemaakt op basis van de SAS-bewerking List 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 om toegang te krijgen met op rollen gebaseerd toegangsbeheer van Azure en fijnmazige controle tot de vervaldatum, frequentie en gebruiksregio(s) voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen in staat te stellen toegang op een veiligere manier te beheren dan de gedeelde sleutel.

Voor openbaar beschikbaar gemaakte toepassingen wordt aanbevolen om een specifieke lijst met toegestane origins te configureren voor de resource van het kaartaccount om misbruik van rendering te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

Successfully retrieve a route between an origin and a destination

Sample Request

HTTP

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

Sample Response

Status code:

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 optimalisatie, met betrekking tot de gegeven planningscriteria, van de berekende alternatieven ten opzichte van de referentieroute.
ComputeTravelTime	Hiermee geeft u op of extra reistijden moeten worden geretourneerd met behulp van verschillende typen verkeersinformatie (geen, historisch, live) en de standaard best geschatte reistijd.
DelayMagnitude	De omvang van de vertraging veroorzaakt door het incident. Deze waarden komen overeen met de waarden van het antwoordveld van de API Details van verkeersincident ophalen.
DrivingSide	Hiermee wordt links versus rechts rijden op het punt van de manoeuvre aangegeven.
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 van de instructie, bijvoorbeeld het draaien of wijzigen van het wegformulier.
GuidanceManeuver	Een code die de manoeuvre identificeert.
InclineLevel	Mate van heuvelachtigheid voor spannende route. Deze parameter kan alleen worden gebruikt in combinatie met routeType=thrilling.
JunctionType	Het type van de kruising waar de manoeuvre plaatsvindt. Voor grotere rotondes worden twee afzonderlijke instructies gegenereerd voor het in- en uitrijden 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	Reismodus voor de berekende route. De waarde wordt ingesteld op other als het aangevraagde transportmiddel in deze sectie niet mogelijk is
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 '&avoid=motorways&avoid=tollRoads&avoid=ferries'. In Aanvragen voor routebereik mag de waarde alreadyUsedRoads niet worden gebruikt.
RouteDirections	Dit object wordt geretourneerd na een geslaagde routebeschrijvingsaanroep
RouteGuidance	Bevat richtlijnen gerelateerde elementen. Dit veld is alleen aanwezig wanneer er richtlijnen zijn aangevraagd en beschikbaar is.
RouteInstruction	Een set kenmerken die een manoeuvre beschrijven, bijvoorbeeld 'Rechts afslaan', 'Links houden', 'Neem de veerboot', 'Neem de snelweg', 'Aankomst'.
RouteInstructionGroup	Groepen een reeks instructie-elementen die aan elkaar zijn gerelateerd. Het reeksbereik wordt beperkt met firstInstructionIndex en lastInstructionIndex. Wanneer door mensen leesbare sms-berichten worden aangevraagd voor hulp (instructionType=text of getagd), wordt in de instructionGroup een overzichtsbericht geretourneerd indien beschikbaar.
RouteInstructionsType	Indien opgegeven, worden richtlijnen 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 in de aanvraag resulteert in een extra poot in de geretourneerde route.
RouteLegSummary	Samenvattingsobject voor routesectie.
RouteOptimizedWaypoint	Geoptimaliseerd way point-object.
RouteReport	Rapporteert de effectieve instellingen die in de huidige aanroep worden gebruikt.
RouteRepresentationForBestOrder	Hiermee geeft u de weergave van de set routes opgegeven als antwoord. Deze parameterwaarde kan alleen worden gebruikt in combinatie met computeBestOrder=true.
RouteSection	Routesecties bevatten aanvullende informatie over onderdelen van een route. Elke sectie bevat ten minste de elementen startPointIndex, endPointIndexen sectionType.
RouteSectionTec	Details van de verkeersgebeurtenis, met behulp van definities in de TPEG2-TEC-standaard . Kan effectCode bevatten en veroorzaakt elementen.
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 dat is aangevraagd.
SectionType	Hiermee geeft u op welke van de sectietypen wordt gerapporteerd in het antwoord van de route. Bijvoorbeeld als sectionType = voetganger de secties die alleen geschikt zijn voor voetgangers worden geretourneerd. Er kunnen meerdere typen worden gebruikt. Het standaard sectionType verwijst naar de travelMode-invoer. TravelMode is standaard ingesteld op auto
SimpleCategory	Type van het incident. Kan momenteel JAM, ROAD_WORK, ROAD_CLOSURE of OVERIGE zijn. Zie 'tec' voor gedetailleerde informatie.
TravelMode	De manier van reizen 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. Als de aangevraagde travelMode niet beschikbaar is voor een bepaalde sectie, is het travelMode-element van het antwoord voor die sectie 'overige'. Houd er rekening mee dat reismodi bus, motor, taxi en busje beta-functionaliteit zijn. Volledige beperkingsgegevens zijn niet in alle gebieden beschikbaar.
VehicleEngineType	Motortype van het voertuig. Wanneer een gedetailleerd verbruiksmodel wordt opgegeven, moet dit consistent zijn met de waarde van vehicleEngineType.
VehicleLoadType	Soorten ladingen die kunnen worden geclassificeerd als gevaarlijke materialen en beperkt zijn vanaf bepaalde wegen. Beschikbare vehicleLoadType-waarden zijn Amerikaanse 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 otherHazmat 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	Niveau van bochten voor spannende route. Deze parameter kan alleen worden gebruikt in combinatie met routeType=thrilling.

AlternativeRouteType

Bepaalt de optimalisatie, met betrekking tot de gegeven planningscriteria, van de berekende alternatieven ten opzichte van de referentieroute.

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

ComputeTravelTime

Hiermee geeft u op of extra reistijden moeten worden geretourneerd met behulp van verschillende typen verkeersinformatie (geen, historisch, live) en de standaard best geschatte 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 veroorzaakt door het incident. Deze waarden komen overeen met de waarden van het antwoordveld van de API Details van verkeersincident ophalen.

Name	Type	Description
0	string	Onbekend.
1	string	Kleine.
2	string	Gemiddeld.
3	string	Belangrijke.
4	string	Ongedefinieerd, gebruikt voor wegafsluitingen en andere onbepaalde vertragingen.

DrivingSide

Hiermee wordt links versus rechts rijden op het punt van de manoeuvre aangegeven.

Name	Type	Description
LEFT	string	Linkerkant.
RIGHT	string	Rechterkant.

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 type aanvullende informatie.

ErrorDetail

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Aanvullende informatie over de fout.
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 van de instructie, bijvoorbeeld het draaien of wijzigen van het wegformulier.

Name	Type	Description
DIRECTION_INFO	string	Richtingsinformatie.
LOCATION_ARRIVAL	string	Aankomstlocatie.
LOCATION_DEPARTURE	string	Vertreklocatie.
LOCATION_WAYPOINT	string	Locatie van way point.
ROAD_CHANGE	string	Wegwijziging.
TURN	string	Draai.

GuidanceManeuver

Een code die de manoeuvre identificeert.

Name	Type	Description
ARRIVE	string	Je bent gearriveerd.
ARRIVE_LEFT	string	Je bent gearriveerd. Uw bestemming bevindt zich aan de linkerkant.
ARRIVE_RIGHT	string	Je bent gearriveerd. Uw bestemming bevindt zich aan de rechterkant.
BEAR_LEFT	string	Houd links aan.
BEAR_RIGHT	string	Houd gelijk.
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	Rechts aanhouden.
MAKE_UTURN	string	Maak een U-bocht.
MOTORWAY_EXIT_LEFT	string	Neem de linkerafrit.
MOTORWAY_EXIT_RIGHT	string	Neem de rechterafrit.
ROUNDABOUT_BACK	string	Rond de rotonde.
ROUNDABOUT_CROSS	string	Steek de rotonde over.
ROUNDABOUT_LEFT	string	Op de rotonde neemt u de afslag aan de linkerkant.
ROUNDABOUT_RIGHT	string	Op de rotonde neemt u de afslag aan de rechterkant.
SHARP_LEFT	string	Ga scherp naar links.
SHARP_RIGHT	string	Draai scherp naar rechts.
STRAIGHT	string	Blijf rechtdoor.
SWITCH_MAIN_ROAD	string	Stap over op de hoofdweg.
SWITCH_PARALLEL_ROAD	string	Schakel over naar de parallelle weg.
TAKE_EXIT	string	Neem de afslag.
TAKE_FERRY	string	Neem de veerboot.
TRY_MAKE_UTURN	string	Probeer een u-bocht 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 is aan de rechterkant.

InclineLevel

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

Name	Type	Description
high	string	hoog
low	string	Lage
normal	string	Normale

JunctionType

Het type van de kruising waar de manoeuvre plaatsvindt. Voor grotere rotondes worden twee afzonderlijke instructies gegenereerd voor het in- en uitrijden van de rotonde.

Name	Type	Description
BIFURCATION	string	Bifurcatie
REGULAR	string	Regelmatige
ROUNDABOUT	string	Rotonde

LatLongPair

Een locatie die wordt weergegeven als een breedtegraad en lengtegraad.

Name	Type	Description
latitude	number	De eigenschap Breedtegraad
longitude	number	De 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 JavaScript Object Notation Data Interchange-indeling
xml	string	De uitbreidbare opmaaktaal

ResponseSectionType

Sectietypen van het gerapporteerde routeantwoord

Name	Type	Description
CARPOOL	string	Gedeelten van de route waarvoor gebruik moet worden gemaakt van carpoolbanen (HOV/High Occupancy Vehicle).
CAR_TRAIN	string	Gedeelten van de route die auto's of treinen zijn.
COUNTRY	string	Secties waarin wordt aangegeven in welke landen/regio's de route zich bevindt.
FERRY	string	Gedeelten 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	Gedeelten van de route waarvoor een tol moet worden betaald.
TOLL_VIGNETTE	string	Gedeelten van de route waarvoor een tol-vignet is vereist.
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 binnen stedelijke gebieden liggen.

ResponseTravelMode

Reismodus voor de berekende route. De waarde wordt ingesteld op other als het aangevraagde transportmiddel in deze sectie niet mogelijk is

Name	Type	Description
bicycle	string	De geretourneerde routes zijn geoptimaliseerd voor fietsen, inclusief het gebruik van fietspaden.
bus	string	De geretourneerde routes zijn geoptimaliseerd voor bussen, inclusief het gebruik van alleen busrijen. BETA-functionaliteit.
car	string	De geretourneerde routes zijn geoptimaliseerd voor auto's.
motorcycle	string	De geretourneerde routes zijn geoptimaliseerd voor motorfietsen. BETA-functionaliteit.
other	string	De opgegeven wijze van vervoer is niet mogelijk in deze sectie
pedestrian	string	De geretourneerde routes zijn geoptimaliseerd voor voetgangers, inclusief het gebruik van trottoirs.
taxi	string	De geretourneerde routes zijn geoptimaliseerd voor taxi's. BETA-functionaliteit.
truck	string	De geretourneerde routes zijn geoptimaliseerd voor bedrijfsvoertuigen, zoals voor vrachtwagens.
van	string	De geretourneerde routes zijn geoptimaliseerd voor busjes. BETA-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[]	Matrix benen
sections	RouteSection[]	Sectiematrix
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 '&avoid=motorways&avoid=tollRoads&avoid=ferries'. In Aanvragen voor routebereik mag de waarde alreadyUsedRoads niet worden gebruikt.

Name	Type	Description
alreadyUsedRoads	string	Vermijdt het gebruik van dezelfde weg meerdere keren. Het meest nuttig in combinatie met routeType=spannend.
borderCrossings	string	Vermijdt grensoverschrijdingen in routeberekening.
carpools	string	Vermijdt routes waarvoor het gebruik van carpoolbanen (HOV/High Occupancy Vehicle) is vereist.
ferries	string	Vermijdt veerboten
motorways	string	Vermijdt snelwegen
tollRoads	string	Vermijdt tolwegen.
unpavedRoads	string	Vermijdt onverharde wegen

RouteDirections

Dit object wordt geretourneerd na een geslaagde routebeschrijvingsaanroep

Name	Type	Description
formatVersion	string	De eigenschap Versie opmaken
optimizedWaypoints	RouteOptimizedWaypoint[]	Geoptimaliseerde volgorde van waypoints. Het toont de index van de door de gebruiker opgegeven 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] is en dat de geoptimaliseerde reeks [1, 2, 0] is. Omdat de index begint met 0, is het origineel 'eerste, tweede, derde' terwijl de geoptimaliseerde is 'tweede, derde, eerste'.
report	RouteReport	Rapporteert de effectieve instellingen die in de huidige aanroep worden gebruikt.
routes	Route[]	Routes-matrix

RouteGuidance

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

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

RouteInstruction

Een set kenmerken die een manoeuvre beschrijven, bijvoorbeeld 'Rechts afslaan', 'Links houden', 'Neem de veerboot', 'Neem de snelweg', 'Aankomst'.

Name	Type	Description
combinedMessage	string	Een door mensen leesbaar 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 deze 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 vlag possibleCombineWithNext 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 om door mensen leesbare richtlijnen vragen. 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	ISO 3166-1 alfa-3-landcode van 3 tekens. B.v. USA.
drivingSide	DrivingSide	Geeft links versus rechts rijden aan op het punt van de manoeuvre.
exitNumber	string	Het nummer of de nummers van een snelwegafrit genomen door de huidige manoeuvre. Als een uitgang meerdere afsluitnummers heeft, worden deze gescheiden door ',' en mogelijk geaggregeerd door '-', bijvoorbeeld '10, 13-15'.
instructionType	GuidanceInstructionType	Type van de instructie, bijvoorbeeld omdraaien of wijzigen van wegformulier.
junctionType	JunctionType	Het type kruising waar de manoeuvre plaatsvindt. Voor grotere rotondes worden twee afzonderlijke instructies gegenereerd voor het betreden en verlaten van de rotonde.
maneuver	GuidanceManeuver	Een code die de manoeuvre identificeert.
message	string	Een door mensen leesbaar 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 de instructie eventueel te combineren met de volgende. Dit kan worden gebruikt voor het samenstellen van berichten zoals 'Draai links en ga vervolgens naar rechts'.
roadNumbers	string[]	Het wegnummer van de volgende significante wegsegment(en) na de manoeuvre, of van de te volgen weg(en). Voorbeeld: ["E34", "N205"]
roundaboutExitNumber	string	Dit geeft aan welke afslag moet worden aangegeven bij een rotonde.
routeOffsetInMeters	integer	Afstand van het begin van de route tot het punt van de instructie.
signpostText	string	De tekst op een wegwijzer die het meest relevant is voor de manoeuvre, of voor 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 bepaalde landen/regio's, zoals de VS, Canada en Mexico.
street	string	Straatnaam van het volgende belangrijke 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 turn-instructie aangeeft: 180 = U-draai [-179, -1] = linksom 0 = Rechtdoor (een draai van 0 graden) [1, 179] = Afslag rechts Als junctionType een bifurcation-instructie aangeeft: <0 - links houden >0 - rechts houden

RouteInstructionGroup

Groepen een reeks instructie-elementen die aan elkaar zijn gerelateerd. Het reeksbereik wordt beperkt met firstInstructionIndex en lastInstructionIndex. Wanneer door mensen leesbare sms-berichten worden aangevraagd voor hulp (instructionType=text of getagd), wordt in de instructionGroup een overzichtsbericht geretourneerd indien beschikbaar.

Name	Type	Description
firstInstructionIndex	integer	Index van de eerste instructie in de instructies en behorend tot deze groep.
groupLengthInMeters	integer	Lengte van de groep.
groupMessage	string	Samenvattingsbericht wanneer door mensen leesbare sms-berichten worden aangevraagd voor hulp (instructionType=text of getagd).
lastInstructionIndex	integer	Index van de laatste instructie in de instructies en behorend tot deze groep.

RouteInstructionsType

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

Name	Type	Description
coded	string	Retourneert onbewerkte instructiegegevens zonder door mensen leesbare berichten.
tagged	string	Retourneert onbewerkte instructiegegevens met gelabelde door mensen leesbare berichten om opmaak toe te laten. Een door mensen leesbaar bericht is opgebouwd uit herhaalbare geïdentificeerde elementen. Deze worden gelabeld zodat clienttoepassingen ze correct kunnen formatteren. De volgende berichtonderdelen worden getagd wanneer instructionsType=tagged: straat, wegNummer, signpostText, exitNumber, roundaboutExitNumber. Voorbeeld van het gelabelde 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 in de aanvraag resulteert in een extra poot in de geretourneerde route.

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

RouteLegSummary

Samenvattingsobject voor routesectie.

Name	Type	Description
arrivalTime	string	De geschatte aankomsttijd voor de route of het traject. De tijd is in UTC.
batteryConsumptionInkWh	number	Geschat elektrisch energieverbruik in kilowattuur (kWh) met behulp van het electric consumption model. Opgenomen als vehicleEngineType is ingesteld op elektrisch en constantSpeedConsumptionInkWhPerHundredkm is opgegeven. De waarde van batteryConsumptionInkWh omvat de gerecupereerde elektrische energie en kan daarom negatief zijn (wat op het winnen van energie duidt). Als zowel maxChargeInkWh als currentChargeInkWh zijn opgegeven, wordt de recuperatie beperkt om ervoor te zorgen dat het oplaadniveau van de accu nooit hoger is dan maxChargeInkWh. Als maxChargeInkWh en currentChargeInkWh niet zijn opgegeven, wordt in de verbruiksberekening uitgegaan van een ongeconstrainde recuperatie.
departureTime	string	De geschatte vertrektijd voor de route of het traject. De tijd is in UTC.
fuelConsumptionInLiters	number	Geschat brandstofverbruik in liter met behulp van het verbrandingsverbruiksmodel. Opgenomen als vehicleEngineType is ingesteld op verbranding en constantSpeedConsumptionInLitersPerHundredkm is opgegeven. De waarde is niet-negatief.
historicTrafficTravelTimeInSeconds	integer	Geschatte reistijd berekend op basis van tijdafhankelijke historische verkeersgegevens. Alleen opgenomen als computeTravelTimeFor = all wordt gebruikt in de query.
lengthInMeters	integer	Eigenschap Lengte in meters
liveTrafficIncidentsTravelTimeInSeconds	integer	Geschatte reistijd berekend met behulp van realtime snelheidsgegevens. Alleen opgenomen als computeTravelTimeFor = all wordt gebruikt in de query.
noTrafficTravelTimeInSeconds	integer	Geschatte reistijd berekend alsof er geen vertragingen zijn op de route als gevolg van verkeerssituaties (bijvoorbeeld congestie). Alleen opgenomen als computeTravelTimeFor = all wordt gebruikt in de query.
trafficDelayInSeconds	integer	Geschatte vertraging in seconden veroorzaakt door de realtime incident(s) op basis van verkeersinformatie. Voor routes die zijn gepland met de vertrektijd in de toekomst, is de vertraging altijd 0. Als u extra reistijden wilt retourneren met behulp van verschillende typen verkeersinformatie, moet de parameter computeTravelTimeFor=all worden toegevoegd.
travelTimeInSeconds	integer	De eigenschap Geschatte reistijd in seconden die de vertraging als gevolg van realtimeverkeer bevat. Houd er rekening mee dat zelfs wanneer traffic=false travelTimeInSeconds nog steeds de vertraging als gevolg van verkeer bevat. Als DepartAt zich in de toekomst bevindt, wordt de reistijd berekend met behulp van 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 die door de gebruiker is opgegeven.

RouteReport

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

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. Deze parameterwaarde kan alleen worden gebruikt in combinatie met computeBestOrder=true.

Name	Type	Description
none	string	Bevat alleen de geoptimaliseerde waypoint-indexen, maar neemt de routegeometrie niet op in het antwoord.
polyline	string	Bevat routegeometrie in het antwoord.
summaryOnly	string	Samenvatting per polylijn, maar met uitzondering van 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	De 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 waar deze sectie op van toepassing is.
magnitudeOfDelay	DelayMagnitude	De omvang van de vertraging die door het incident wordt veroorzaakt. Deze waarden komen overeen met de waarden van het antwoordveld van de API Verkeersincidentdetails ophalen.
sectionType	ResponseSectionType	Sectietypen van het gerapporteerde routeantwoord
simpleCategory	SimpleCategory	Type van het incident. Kan momenteel JAM, ROAD_WORK, ROAD_CLOSURE of OVERIG 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	Reismodus voor de berekende route. De waarde wordt ingesteld op other als het aangevraagde transportmiddel niet mogelijk is in deze sectie

RouteSectionTec

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

Name	Type	Description
causes	RouteSectionTecCause[]	Oorzaken matrix
effectCode	integer	Het effect op de verkeersstroom. Bevat een waarde in de tabel tec001:EffectCode, zoals gedefinieerd in de TPEG2-TEC-standaard . 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 hoofdoorzaak van de verkeers gebeurtenis. Bevat een waarde in de tabel tec002:CauseCode, zoals gedefinieerd in de TPEG2-TEC-standaard .
subCauseCode	integer	De subcause van de verkeers gebeurtenis. Bevat een waarde in de suboorzaaktabel die is gedefinieerd door de mainCauseCode, zoals gedefinieerd in de TPEG2-TEC-standaard .

RouteSummary

Samenvattingsobject

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

RouteType

Het type route dat is 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 gebruikt zo min mogelijk snelwegen. U kunt het niveau van de inbegrepen bochten en ook de mate van heuvelachtigheid kiezen. Bekijk de parameters heuvelachtigheid en windingness om dit in te stellen. Er is een limiet van 900 km op routes gepland met routeType=spannend

SectionType

Hiermee geeft u op welke van de sectietypen wordt gerapporteerd in het antwoord van de route.

Bijvoorbeeld als sectionType = voetganger de secties die alleen geschikt zijn voor voetgangers worden geretourneerd. Er kunnen meerdere typen worden gebruikt. Het standaard sectionType verwijst naar de travelMode-invoer. TravelMode is standaard ingesteld op auto

Name	Type	Description
carTrain	string	Gedeelten van de route die auto's of treinen zijn.
carpool	string	Gedeelten van de route waarvoor gebruik moet worden gemaakt van carpoolbanen (HOV/High Occupancy Vehicle).
country	string	Secties waarin wordt aangegeven in welke landen/regio's de route zich bevindt.
ferry	string	Gedeelten 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	Gedeelten van de route waarvoor een tol moet worden betaald.
tollVignette	string	Gedeelten van de route waarvoor een tol-vignet is vereist.
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 binnen stedelijke gebieden liggen.

SimpleCategory

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

Name	Type	Description
JAM	string	Verkeersopstopping.
OTHER	string	Iets anders.
ROAD_CLOSURE	string	Wegsluiting.
ROAD_WORK	string	Wegwerkzaamheden.

TravelMode

De manier van reizen 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. Als de aangevraagde travelMode niet beschikbaar is voor een bepaalde sectie, is het travelMode-element van het antwoord voor die sectie 'overige'. Houd er rekening mee dat reismodi bus, motor, taxi en busje beta-functionaliteit zijn. Volledige beperkingsgegevens zijn niet in alle gebieden beschikbaar.

Name	Type	Description
bicycle	string	De geretourneerde routes zijn geoptimaliseerd voor fietsen, inclusief het gebruik van fietspaden.
bus	string	De geretourneerde routes zijn geoptimaliseerd voor bussen, inclusief het gebruik van alleen busrijen. BETA-functionaliteit.
car	string	De geretourneerde routes zijn geoptimaliseerd voor auto's.
motorcycle	string	De geretourneerde routes zijn geoptimaliseerd voor motorfietsen. BETA-functionaliteit.
pedestrian	string	De geretourneerde routes zijn geoptimaliseerd voor voetgangers, inclusief het gebruik van trottoirs.
taxi	string	De geretourneerde routes zijn geoptimaliseerd voor taxi's. BETA-functionaliteit.
truck	string	De geretourneerde routes zijn geoptimaliseerd voor bedrijfsvoertuigen, zoals voor vrachtwagens.
van	string	De geretourneerde routes zijn geoptimaliseerd voor busjes. BETA-functionaliteit.

VehicleEngineType

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

Name	Type	Description
combustion	string	Verbrandingsmotor.
electric	string	Elektrische motor.

VehicleLoadType

Soorten ladingen die kunnen worden geclassificeerd als gevaarlijke materialen en beperkt zijn vanaf bepaalde wegen. Beschikbare vehicleLoadType-waarden zijn Amerikaanse 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 otherHazmat 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	Samengeperst gas
USHazmatClass3	string	Ontvlambare vloeistoffen
USHazmatClass4	string	Ontvlambare vaste stoffen
USHazmatClass5	string	Oxiderende stoffen
USHazmatClass6	string	Vergif
USHazmatClass7	string	Radioactief
USHazmatClass8	string	Corrosief materiaal
USHazmatClass9	string	Diversen
otherHazmatExplosive	string	Explosieven
otherHazmatGeneral	string	Diversen
otherHazmatHarmfulToWater	string	Schadelijk voor water

WindingnessLevel

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

Name	Type	Description
high	string	hoog
low	string	Lage
normal	string	Normale