Route - Post Route Matrix

Service:

Maps

API Version:

1.0

Gebruik om een routematrix op te halen met de reistijd en afstand voor alle mogelijke paren in een lijst met oorsprongen en bestemmingen, met behulp van een asynchrone aanvraag.

De Post Route Matrix API is een HTTP-aanvraag POST waarmee een matrix van routesamenvattingen kan worden berekend voor een set routes die zijn gedefinieerd op oorsprongs- en doellocaties met behulp van een asynchrone (asynchrone) aanvraag. Zie Post Route Matrix Sync als u een synchrone (synchronisatie)-aanvraag wilt maken. Voor elke opgegeven oorsprong berekent de service de kosten van routering van die oorsprong naar elke opgegeven bestemming. De reeks oorsprongen en de reeks bestemmingen kunnen worden beschouwd als de kolom- en rijkoppen van een tabel en elke cel in de tabel bevat de kosten van routering van de oorsprong naar de bestemming voor die cel. Stel dat een bezorgbedrijf 20 chauffeurs heeft en dat ze de dichtstbijzijnde chauffeur moeten vinden om de bezorging in het restaurant op te halen. Om dit gebruiksscenario op te lossen, kunnen ze Matrix Route-API aanroepen.

Voor elke route worden de reistijden en afstanden geretourneerd. U kunt de berekende kosten gebruiken om te bepalen welke gedetailleerde routes moeten worden berekend met behulp van de Route directions-API.

De maximale grootte van een matrix voor een asynchrone aanvraag is 700 en voor een synchronisatieaanvraag 100 (het aantal oorsprongen vermenigvuldigd met het aantal bestemmingen).

Aanvraag voor synchrone routematrix indienen

Als uw scenario synchrone aanvragen vereist en de maximale grootte van de matrix kleiner is dan of gelijk is aan 100, kunt u een synchrone aanvraag indienen. De maximale grootte van een matrix voor deze API is 100 (het aantal origins vermenigvuldigd met het aantal bestemmingen). Met deze beperking in het achterhoofd zijn voorbeelden van mogelijke matrixdimensies: 10x10, 6x8, 9x8 (deze hoeft niet vierkant te zijn).

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}

Aanvraag voor asynchrone routematrix verzenden

De asynchrone API is geschikt voor het verwerken van grote volumes van relatief complexe routeringsaanvragen. Wanneer u een aanvraag doet met behulp van een asynchrone aanvraag, retourneert de service standaard een 202-antwoordcode samen met een omleidings-URL in het veld Locatie van de antwoordheader. Deze URL moet regelmatig worden gecontroleerd totdat de antwoordgegevens of foutinformatie beschikbaar zijn. Als waitForResults de parameter in de aanvraag is ingesteld op true, krijgt de gebruiker een 200-antwoord als de aanvraag binnen 120 seconden is voltooid.

De maximale grootte van een matrix voor deze API is 700 (het aantal oorsprongen vermenigvuldigd met het aantal bestemmingen). Met deze beperking in het achterhoofd zijn voorbeelden van mogelijke matrixdimensies: 50x10, 10x10, 28x25. 10x70 (het hoeft niet vierkant te zijn).

De asynchrone antwoorden worden 14 dagen opgeslagen. De omleidings-URL retourneert een 404-antwoord als deze na de verloopperiode wordt gebruikt.

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

Hier volgt een typische reeks asynchrone bewerkingen:

1. Client verzendt een Route Matrix POST-aanvraag naar Azure Maps

2. De server reageert met een van de volgende opties:

   HTTP 202 Accepted : routematrixaanvraag is geaccepteerd.

   HTTP Error : er is een fout opgetreden bij het verwerken van uw Route Matrix-aanvraag. Dit kan een ongeldige 400-aanvraag of een andere foutcode zijn.

3. Als de MatrixRoute-aanvraag is geaccepteerd, bevat de locatieheader in het antwoord de URL om de resultaten van de aanvraag te downloaden. Deze status-URI ziet er als volgt uit:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

4. Client verzendt een GET-aanvraag op de download-URL die in stap 3 is verkregen om de resultaten te downloaden

Synchronisatieresultaten downloaden

Wanneer u een POST-aanvraag voor routematrixsynchronisatie-API maakt, retourneert de service 200-antwoordcode voor een geslaagde aanvraag en een antwoordmatrix. De antwoordtekst bevat de gegevens en er is geen mogelijkheid om de resultaten later op te halen.

Asynchrone resultaten downloaden

Wanneer een aanvraag een 202 Accepted antwoord geeft, wordt de aanvraag verwerkt met behulp van onze asynchrone pijplijn. U krijgt een URL om de voortgang van uw asynchrone aanvraag te controleren in de locatieheader van het antwoord. Deze status-URI ziet er als volgt uit:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

De URL die door de locatieheader wordt opgegeven, retourneert de volgende antwoorden wanneer een GET aanvraag wordt verzonden.

HTTP 202 Accepted : matrixaanvraag is geaccepteerd, maar wordt nog steeds verwerkt. Probeer het over enige tijd opnieuw.

HTTP 200 OK : matrixaanvraag is verwerkt. De hoofdtekst van het antwoord bevat alle resultaten.

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0

With optional parameters:

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&waitForResults={waitForResults}&computeTravelTimeFor={computeTravelTimeFor}&sectionType={sectionType}&arriveAt={arriveAt}&departAt={departAt}&vehicleAxleWeight={vehicleAxleWeight}&vehicleLength={vehicleLength}&vehicleHeight={vehicleHeight}&vehicleWidth={vehicleWidth}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&windingness={windingness}&hilliness={hilliness}&travelMode={travelMode}&avoid={avoid}&traffic={traffic}&routeType={routeType}&vehicleLoadType={vehicleLoadType}

URI-parameters

Name	In	Vereist	Type	Description
format	path	True	JsonFormat	Gewenste indeling van het antwoord. Alleen json de indeling wordt ondersteund.
api-version	query	True	string	Versienummer van Azure Maps API.
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 offset. Wanneer er geen tijdzoneverschil wordt opgegeven, wordt ervan uitgegaan dat deze dat 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.
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=snelwegen&avoid=tollRoads&avoid=ferries'. In Aanvragen voor routebereik mag de waarde alreadyUsedRoads niet worden gebruikt.
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.
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 tijdzone-verschuiving is opgegeven, wordt ervan uitgegaan dat dit het punt van oorsprong 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.
hilliness	query		InclineLevel	Mate van heuvelachtigheid voor spannende route. Deze parameter kan alleen worden gebruikt in combinatie met routeType=thrilling.
routeType	query		RouteType	Het type route dat is aangevraagd.
sectionType	query		SectionType	Hiermee geeft u op welke van de sectietypen wordt gerapporteerd in het routeantwoord. 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 invoer travelMode. TravelMode is standaard ingesteld op auto
traffic	query		boolean	Mogelijke waarden: true- Houd rekening met alle beschikbare verkeersinformatie tijdens routering false: negeer de huidige verkeersgegevens tijdens routering. 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 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 element travelMode van het antwoord voor die sectie 'other'. Houd er rekening mee dat de reismodi bus, motorfiets, taxi en busje BÈTA-functionaliteit zijn. Volledige beperkingsgegevens zijn niet in alle gebieden beschikbaar.
vehicleAxleWeight	query		integer	Gewicht per as van het voertuig in kg. Een waarde van 0 betekent dat er geen rekening wordt gehouden met gewichtsbeperkingen per as.
vehicleHeight	query		number double	Hoogte van het voertuig in meters. Een waarde van 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 lengtebeperkingen niet in aanmerking worden genomen.
vehicleLoadType	query		VehicleLoadType	Soorten ladingen die kunnen worden geclassificeerd als gevaarlijke materialen en beperkt zijn vanaf sommige wegen. Beschikbare vehicleLoadType-waarden zijn De 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 passende 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 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 kilogrammen.
vehicleWidth	query		number double	Breedte van het voertuig in meters. Een waarde van 0 betekent dat breedtebeperkingen niet in aanmerking worden genomen.
waitForResults	query		boolean	Booleaanse waarde om aan te geven of de aanvraag synchroon moet worden uitgevoerd. Als deze optie is ingesteld op true, krijgt de gebruiker een 200-antwoord als de aanvraag minder dan 120 seconden is voltooid. Anders krijgt de gebruiker direct een 202-antwoord. Raadpleeg de API-beschrijving voor meer informatie over het 202-antwoord. Alleen ondersteund voor asynchrone aanvragen.
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.

Aanvraagbody

Name	Type	Description
destinations	GeoJsonMultiPoint	Een geldig GeoJSON MultiPoint geometrietype. Raadpleeg RFC 7946 voor meer informatie.
origins	GeoJsonMultiPoint	Een geldig GeoJSON MultiPoint geometrietype. Raadpleeg RFC 7946 voor meer informatie.

Antwoorden

Name	Type	Description
200 OK	RouteMatrixResult	De matrixaanvraag is verwerkt. De hoofdtekst van het antwoord bevat alle resultaten.
202 Accepted		Alleen ondersteund voor asynchrone aanvragen. Aanvraag geaccepteerd: de aanvraag is geaccepteerd voor verwerking. Gebruik de URL in de Locatieheader om de resultaten opnieuw te proberen of te openen. Headers Location: string
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 submit a route matrix request

Sample Request

HTTP

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&routeType=shortest

{
  "origins": {
    "type": "MultiPoint",
    "coordinates": [
      [
        4.85106,
        52.36006
      ],
      [
        4.85056,
        52.36187
      ]
    ]
  },
  "destinations": {
    "type": "MultiPoint",
    "coordinates": [
      [
        4.85003,
        52.36241
      ],
      [
        13.42937,
        52.50931
      ]
    ]
  }
}

Sample Response

Status code:

200

{
  "formatVersion": "0.0.1",
  "matrix": [
    [
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 495,
            "travelTimeInSeconds": 134,
            "trafficDelayInSeconds": 0,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-27T22:57:43+00:00"
          }
        }
      },
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 647651,
            "travelTimeInSeconds": 26835,
            "trafficDelayInSeconds": 489,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-28T06:22:44+00:00"
          }
        }
      }
    ],
    [
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 338,
            "travelTimeInSeconds": 104,
            "trafficDelayInSeconds": 0,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-27T22:57:13+00:00"
          }
        }
      },
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 647494,
            "travelTimeInSeconds": 26763,
            "trafficDelayInSeconds": 469,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-28T06:21:32+00:00"
          }
        }
      }
    ]
  ],
  "summary": {
    "successfulRoutes": 4,
    "totalRoutes": 4
  }
}

Status code:

202

operation-Location: New URL to check the status of the long-running operation.

Definities

Name	Description
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.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
GeoJsonMultiPoint	Een geldig GeoJSON MultiPoint geometrietype. Raadpleeg RFC 7946 voor meer informatie.
InclineLevel	Mate van heuvelachtigheid voor spannende route. Deze parameter kan alleen worden gebruikt in combinatie met routeType=thrilling.
JsonFormat	Gewenste indeling van het antwoord. Alleen json de indeling wordt ondersteund.
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.
RouteLegSummary	Samenvattingsobject voor routesectie.
RouteMatrix	Matrixresultaatobject
RouteMatrixQuery	Een object met een matrix van coördinaten.
RouteMatrixResult	Dit object wordt geretourneerd na een geslaagde Route Matrix-aanroep. Als er bijvoorbeeld 2 oorsprongen en 3 bestemmingen worden opgegeven, zijn er 2 matrices met 3 elementen in elk. De inhoud van elk element is afhankelijk van de opties in de query.
RouteMatrixResultResponse	Antwoordobject van de huidige cel in de invoermatrix.
RouteMatrixSummary	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
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.
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.

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.

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.

GeoJsonMultiPoint

Een geldig GeoJSON MultiPoint geometrietype. Raadpleeg RFC 7946 voor meer informatie.

Name	Type	Description
coordinates	number[]	Coördinaten voor de GeoJson MultiPoint geometrie.
type	string: MultiPoint	Hiermee geeft u het GeoJSON type op. Moet een van de negen geldige GeoJSON-objecttypen zijn: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

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

JsonFormat

Gewenste indeling van het antwoord. Alleen json de indeling wordt ondersteund.

Name	Type	Description
json	string	De JavaScript Object Notation Data Interchange-indeling

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

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 model elektrisch verbruik. Opgenomen als vehicleEngineType is ingesteld op elektrisch en constantSpeedConsumptionInkWhPerHundredkm is opgegeven. De waarde van batteryConsumptionInkWh omvat de gerecupereerde elektrische energie en kan dus negatief zijn (wat wijst op het winnen van energie). Als zowel maxChargeInkWh als currentChargeInkWh zijn opgegeven, wordt recuperatie beperkt om ervoor te zorgen dat het oplaadniveau van de batterij nooit hoger is dan maxChargeInkWh. Als maxChargeInkWh en currentChargeInkWh niet zijn opgegeven, wordt uitgegaan van onbeperkte recuperatie in de verbruiksberekening.
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 op basis 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.

RouteMatrix

Matrixresultaatobject

Name	Type	Description
response	RouteMatrixResultResponse	Antwoordobject van de huidige cel in de invoermatrix.
statusCode	integer	De eigenschap StatusCode voor de huidige cel in de invoermatrix.

RouteMatrixQuery

Een object met een matrix van coördinaten.

Name	Type	Description
destinations	GeoJsonMultiPoint	Een geldig GeoJSON MultiPoint geometrietype. Raadpleeg RFC 7946 voor meer informatie.
origins	GeoJsonMultiPoint	Een geldig GeoJSON MultiPoint geometrietype. Raadpleeg RFC 7946 voor meer informatie.

RouteMatrixResult

Dit object wordt geretourneerd na een geslaagde Route Matrix-aanroep. Als er bijvoorbeeld 2 oorsprongen en 3 bestemmingen worden opgegeven, zijn er 2 matrices met 3 elementen in elk. De inhoud van elk element is afhankelijk van de opties in de query.

Name	Type	Description
formatVersion	string	De eigenschap Versie opmaken
matrix	RouteMatrix[]	Resultaten als een tweedimensionale matrix van routesamenvattingen.
summary	RouteMatrixSummary	Samenvattingsobject

RouteMatrixResultResponse

Antwoordobject van de huidige cel in de invoermatrix.

Name	Type	Description
routeSummary	RouteLegSummary	Samenvattingsobject voor routesectie.

RouteMatrixSummary

Samenvattingsobject

Name	Type	Description
successfulRoutes	integer	Aantal geslaagde routes in het antwoord.
totalRoutes	integer	Totaal aantal aangevraagde routes. Aantal cellen in de invoermatrix.

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.

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.

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