Route - Post Route Matrix Sync
Gebruik dit 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 synchrone aanvraag.
De Post Route Matrix Sync
-API is een HTTP-POST
-aanvraag waarmee een matrix met routesamenvattingen kan worden berekend voor een set routes die zijn gedefinieerd door oorsprongs- en doellocaties met behulp van één synchrone aanvraag (synchronisatie). Zie Post Route Matrixom een asynchrone (asynchrone) aanvraag te maken. Voor elke opgegeven oorsprong berekent de service de kosten van routering van die oorsprong naar elke opgegeven bestemming. De reeks oorsprongen en de set bestemmingen kunnen worden beschouwd als de kolom- en rijkoppen van een tabel en elke cel in de tabel bevat de kosten voor routering van de oorsprong naar de bestemming voor die cel. Stel dat een foodleveringsbedrijf 20 chauffeurs heeft en dat ze de dichtstbijzijnde chauffeur moeten vinden om de levering van het restaurant op te halen. Om deze use-case op te lossen, kunnen ze matrixroute-API aanroepen.
Voor elke route worden de reistijden en afstanden geretourneerd. U kunt de berekende kosten gebruiken om te bepalen welke gedetailleerde routes u wilt berekenen met behulp van de ROUTEBESCHRIJVING-API.
De maximale grootte van een matrix voor asynchrone aanvraag is 700 en voor de synchronisatieaanvraag is het 100 (het aantal oorsprongen vermenigvuldigd met het aantal bestemmingen).
Synchrone routematrixaanvraag verzenden
Als voor uw scenario synchrone aanvragen zijn 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 oorsprongen vermenigvuldigd met het aantal bestemmingen). Met deze beperking in gedachten zijn voorbeelden van mogelijke matrixdimensies: 10x10, 6x8, 9x8 (het hoeft niet vierkant te zijn).
POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}
Asynchrone routematrixaanvraag verzenden
De Asynchrone API is geschikt voor het verwerken van grote volumes van relatief complexe routeringsaanvragen. Wanneer u een aanvraag indient met behulp van een asynchrone aanvraag, retourneert de service standaard een 202-antwoordcode langs een omleidings-URL in het veld Locatie van de antwoordheader. Deze URL moet periodiek worden gecontroleerd totdat de antwoordgegevens of foutgegevens beschikbaar zijn. Als waitForResults
parameter in de aanvraag is ingesteld op waar, 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 gedachten zijn voorbeelden van mogelijke matrixdimensies: 50x10, 10x10, 28x25. 10x70 (het hoeft niet vierkant te zijn).
De asynchrone antwoorden worden gedurende 24 uur opgeslagen. De omleidings-URL retourneert een 404-antwoord als deze wordt gebruikt na de verloopperiode.
POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}
Hier volgt een typische reeks asynchrone bewerkingen:
Client verzendt een Route Matrix POST-aanvraag naar Azure Maps
De server reageert op een van de volgende manieren:
HTTP-
202 Accepted
- Routematrix-aanvraag is geaccepteerd.HTTP-
Error
: er is een fout opgetreden bij het verwerken van uw Route Matrix-aanvraag. Dit kan een ongeldige aanvraag van 400 of een andere foutcode zijn.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}
- Client geeft een GET-aanvraag uit op de download-URL die is verkregen in stap 3 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 hoofdtekst van het antwoord 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 uitgeeft, 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 van de locatieheader retourneert de volgende antwoorden wanneer een GET
aanvraag wordt uitgegeven.
HTTP-
202 Accepted
- Matrix-aanvraag 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/sync/json?api-version=1.0
POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&waitForResults={waitForResults}&computeTravelTimeFor={computeTravelTimeFor}§ionType={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 |
Gewenste indeling van het antwoord. Alleen |
|
api-version
|
query | True |
string |
Versienummer van Azure Maps-API. |
arrive
|
query |
string date-time |
De datum en tijd van aankomst op het doelpunt dat is opgemaakt als een Voorbeelden:
De parameter |
|
avoid
|
query |
Hiermee geeft u iets op dat de routeberekening moet proberen te vermijden bij het bepalen van de route. Kan meerdere keren in één aanvraag worden opgegeven, bijvoorbeeld '&vermijd=snelwegen&vermijden=tollRoads&avoid=veerboten'. In routebereikaanvragen mag de waarde alreadyUsedRoads niet worden gebruikt. |
||
compute
|
query |
Hiermee geeft u op of er extra reistijden moeten worden geretourneerd met behulp van verschillende soorten verkeersinformatie (geen, historisch, live) en de standaard best-schatting reistijd. |
||
depart
|
query |
string date-time |
De datum en tijd van vertrek van het oorspronkelijke punt die zijn opgemaakt als een
Voorbeelden:
De parameter |
|
hilliness
|
query |
Mate van heuveligheid voor spannende route. Deze parameter kan alleen worden gebruikt in combinatie met |
||
route
|
query |
Het type route aangevraagd. |
||
section
|
query |
Hiermee geeft u op welke sectietypen worden gerapporteerd in het routeantwoord. |
||
traffic
|
query |
boolean |
Mogelijke waarden:
|
|
travel
|
query |
De reismodus voor de aangevraagde route. Als dit niet is gedefinieerd, is de standaardwaarde 'auto'. Houd er rekening mee dat de aangevraagde travelMode mogelijk niet beschikbaar is voor de hele route. Wanneer de aangevraagde travelMode niet beschikbaar is voor een bepaalde sectie, is het element travelMode van het antwoord voor die sectie 'overig'. Houd er rekening mee dat reismodi bus, motorfiets, taxi en busje beta-functionaliteit zijn. Volledige beperkingsgegevens zijn niet beschikbaar in alle gebieden. |
||
vehicle
|
query |
integer |
Gewicht per as van het voertuig in kg. Een waarde van 0 betekent dat gewichtsbeperkingen per as niet worden overwogen. |
|
vehicle
|
query |
number double |
Hoogte van het voertuig in meters. Een waarde van 0 betekent dat hoogtebeperkingen niet worden overwogen. |
|
vehicle
|
query |
number double |
Lengte van het voertuig in meters. Een waarde van 0 betekent dat lengtebeperkingen niet worden overwogen. |
|
vehicle
|
query |
Soorten ladingen die kunnen worden geclassificeerd als gevaarlijke materialen en beperkt zijn van sommige wegen. Beschikbare vehicleLoadType-waarden zijn US Hazmat-klassen 1 tot en met 9, plus algemene classificaties voor gebruik in andere landen/regio's. Waarden die beginnen met USHazmat zijn voor amerikaanse routering, terwijl andereHazmat moet worden gebruikt voor alle andere landen/regio's. vehicleLoadType kan meerdere keren worden opgegeven. Deze parameter wordt momenteel alleen in aanmerking genomen voor travelMode=truck. |
||
vehicle
|
query |
integer |
Maximumsnelheid van het voertuig in km/uur. De maximale snelheid in het voertuigprofiel wordt gebruikt om te controleren of een voertuig is toegestaan op snelwegen.
|
|
vehicle
|
query |
integer |
Gewicht van het voertuig in kilogram. |
|
vehicle
|
query |
number double |
Breedte van het voertuig in meters. Een waarde van 0 betekent dat breedtebeperkingen niet worden overwogen. |
|
wait
|
query |
boolean |
Booleaanse waarde die aangeeft of de aanvraag synchroon moet worden uitgevoerd. Als deze optie is ingesteld op true, krijgt de gebruiker een 200-antwoord als de aanvraag binnen 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 aanvraag. |
|
windingness
|
query |
Hoogte van bochten voor spannende route. Deze parameter kan alleen worden gebruikt in combinatie met |
Aanvraagkoptekst
Name | Vereist | Type | Description |
---|---|---|---|
x-ms-client-id |
string |
Hiermee geeft u op welk account is bedoeld voor gebruik in combinatie met het Microsoft Entra ID-beveiligingsmodel. Het vertegenwoordigt een unieke id voor het Azure Maps-account en kan worden opgehaald uit de Account-API van het Azure Maps-beheervlak. Zie de volgende artikelen voor hulp voor het gebruik van Microsoft Entra ID-beveiliging in Azure Maps. |
Aanvraagbody
Name | Type | Description |
---|---|---|
destinations |
Een geldig |
|
origins |
Een geldig |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
Matrixaanvraag is verwerkt. De hoofdtekst van het antwoord bevat alle resultaten. |
|
Other Status Codes |
Time-out: de aanvraag duurde langer om te voltooien dan de maximale tijd die is gedefinieerd in de API. |
|
Other Status Codes |
Er is een onverwachte fout opgetreden. |
Beveiliging
AADToken
Dit zijn de Microsoft Entra OAuth 2.0 Flows. Wanneer deze is gekoppeld aan op rollen gebaseerd toegangsbeheer van Azure kan het worden gebruikt om de toegang tot Azure Maps REST API's te beheren. Op rollen gebaseerd toegangsbeheer van Azure wordt gebruikt om toegang aan te wijzen tot een of meer Azure Maps-resourceaccounts of subresources. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.
Voor het implementeren van scenario's raden we u aan om verificatieconceptente bekijken. Kortom, deze beveiligingsdefinitie biedt een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen uitvoeren voor specifieke API's en bereiken.
Notities
- Deze beveiligingsdefinitie vereist het gebruik van de
x-ms-client-id
-header om aan te geven tot welke Azure Maps-resource de toepassing toegang aanvraagt. Dit kan worden verkregen uit de Maps Management API-.
De Authorization URL
is specifiek voor het exemplaar van de openbare Azure-cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Microsoft Entra ID-configuraties.
* Het op rollen gebaseerde toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.
* Gebruik van de Azure Maps Web SDK maakt configuratiegebaseerde installatie van een toepassing mogelijk voor meerdere gebruiksscenario's.
- Zie Overzicht van Microsoft Identity Platformvoor meer informatie over het Microsoft Identity Platform.
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiken
Name | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Dit is een gedeelde sleutel die wordt ingericht wanneer u Een Azure Maps-account maken in Azure Portal of met behulp van PowerShell, CLI, Azure SDK's of REST API.
Met deze sleutel heeft elke toepassing toegang tot alle REST API's. Met andere woorden, deze sleutel kan worden gebruikt als een hoofdsleutel in het account waarin ze worden uitgegeven.
Voor openbaar blootgestelde toepassingen is het raadzaam om de vertrouwelijke clienttoepassingen te gebruiken benadering voor toegang tot Azure Maps REST API's, zodat uw sleutel veilig kan worden opgeslagen.
Type:
apiKey
In:
query
SAS Token
Dit is een shared access Signature-token dat wordt gemaakt op basis van de bewerking List SAS op de Azure Maps-resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.
Met dit token is elke toepassing gemachtigd voor toegang met op rollen gebaseerd toegangsbeheer van Azure en gedetailleerd beheer tot de vervaldatum, snelheid en regio(s) van gebruik voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen toe te staan toegang op een veiligere manier te beheren dan de gedeelde sleutel.
Voor openbaar blootgestelde toepassingen wordt aangeraden een specifieke lijst met toegestane origins te configureren voor de resource van het Account toewijzen om het genereren van misbruik te beperken en het SAS-token regelmatig te vernieuwen.
Type:
apiKey
In:
header
Voorbeelden
Successfully retrieve a route matrix request result synchronously
Voorbeeldaanvraag
POST https://atlas.microsoft.com/route/matrix/sync/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
]
]
}
}
Voorbeeldrespons
{
"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
}
}
{
"error": {
"code": "408 Timeout",
"message": "Timeout: The request took longer to finish than the maximum amount of time defined in the api."
}
}
Definities
Name | Description |
---|---|
Compute |
Hiermee geeft u op of er extra reistijden moeten worden geretourneerd met behulp van verschillende soorten verkeersinformatie (geen, historisch, live) en de standaard best-schatting reistijd. |
Error |
Aanvullende informatie over de resourcebeheerfout. |
Error |
De foutdetails. |
Error |
Foutreactie |
Geo |
Een geldig |
Incline |
Mate van heuveligheid voor spannende route. Deze parameter kan alleen worden gebruikt in combinatie met |
Json |
Gewenste indeling van het antwoord. Alleen |
Route |
Hiermee geeft u iets op dat de routeberekening moet proberen te vermijden bij het bepalen van de route. Kan meerdere keren in één aanvraag worden opgegeven, bijvoorbeeld '&vermijd=snelwegen&vermijden=tollRoads&avoid=veerboten'. In routebereikaanvragen mag de waarde alreadyUsedRoads niet worden gebruikt. |
Route |
Overzichtsobject voor routesectie. |
Route |
Matrixresultaatobject |
Route |
Een object met een matrix met coördinaten. |
Route |
Dit object wordt geretourneerd door een geslaagde routematrix-aanroep. Als er bijvoorbeeld 2 oorsprongen en 3 bestemmingen worden opgegeven, worden er 2 matrices met 3 elementen in elk opgegeven. De inhoud van elk element is afhankelijk van de opties in de query. |
Route |
Antwoordobject van de huidige cel in de invoermatrix. |
Route |
Samenvattingsobject |
Route |
Het type route aangevraagd. |
Section |
Hiermee geeft u op welke sectietypen worden gerapporteerd in het routeantwoord. |
Travel |
De reismodus voor de aangevraagde route. Als dit niet is gedefinieerd, is de standaardwaarde 'auto'. Houd er rekening mee dat de aangevraagde travelMode mogelijk niet beschikbaar is voor de hele route. Wanneer de aangevraagde travelMode niet beschikbaar is voor een bepaalde sectie, is het element travelMode van het antwoord voor die sectie 'overig'. Houd er rekening mee dat reismodi bus, motorfiets, taxi en busje beta-functionaliteit zijn. Volledige beperkingsgegevens zijn niet beschikbaar in alle gebieden. |
Vehicle |
Soorten ladingen die kunnen worden geclassificeerd als gevaarlijke materialen en beperkt zijn van sommige wegen. Beschikbare vehicleLoadType-waarden zijn US Hazmat-klassen 1 tot en met 9, plus algemene classificaties voor gebruik in andere landen/regio's. Waarden die beginnen met USHazmat zijn voor amerikaanse routering, terwijl andereHazmat moet worden gebruikt voor alle andere landen/regio's. vehicleLoadType kan meerdere keren worden opgegeven. Deze parameter wordt momenteel alleen in aanmerking genomen voor travelMode=truck. |
Windingness |
Hoogte van bochten voor spannende route. Deze parameter kan alleen worden gebruikt in combinatie met |
ComputeTravelTime
Hiermee geeft u op of er extra reistijden moeten worden geretourneerd met behulp van verschillende soorten verkeersinformatie (geen, historisch, live) en de standaard best-schatting reistijd.
Name | Type | Description |
---|---|---|
all |
string |
Berekent reistijden voor alle typen verkeersinformatie en geeft alle resultaten op in de velden noTrafficTravelTimeInSeconds, historicTrafficTravelTimeInSeconds en liveTrafficIncidentsTravelTimeInSeconds die worden opgenomen in de samenvattingen in het routeantwoord. |
none |
string |
Berekent geen extra reistijden. |
ErrorAdditionalInfo
Aanvullende informatie over de resourcebeheerfout.
Name | Type | Description |
---|---|---|
info |
object |
De aanvullende informatie. |
type |
string |
Het extra informatietype. |
ErrorDetail
De foutdetails.
Name | Type | Description |
---|---|---|
additionalInfo |
De fout bevat aanvullende informatie. |
|
code |
string |
De foutcode. |
details |
De foutdetails. |
|
message |
string |
Het foutbericht. |
target |
string |
Het foutdoel. |
ErrorResponse
Foutreactie
Name | Type | Description |
---|---|---|
error |
Het foutobject. |
GeoJsonMultiPoint
Een geldig GeoJSON MultiPoint
geometrietype. Raadpleeg RFC 7946- voor meer informatie.
Name | Type | Description |
---|---|---|
coordinates |
number[] |
Coördinaten voor de |
type |
string:
Multi |
Hiermee geeft u het |
InclineLevel
Mate van heuveligheid voor spannende route. Deze parameter kan alleen worden gebruikt in combinatie met routeType
=spannende.
Name | Type | Description |
---|---|---|
high |
string |
hoog |
low |
string |
laag |
normal |
string |
normaal |
JsonFormat
Gewenste indeling van het antwoord. Alleen json
indeling wordt ondersteund.
Name | Type | Description |
---|---|---|
json |
string |
De Notatie Data Interchange-indeling voor JavaScript-objecten |
RouteAvoidType
Hiermee geeft u iets op dat de routeberekening moet proberen te vermijden bij het bepalen van de route. Kan meerdere keren in één aanvraag worden opgegeven, bijvoorbeeld '&vermijd=snelwegen&vermijden=tollRoads&avoid=veerboten'. In routebereikaanvragen mag de waarde alreadyUsedRoads niet worden gebruikt.
Name | Type | Description |
---|---|---|
alreadyUsedRoads |
string |
Vermijd het gebruik van dezelfde weg meerdere keren. Meest nuttig in combinatie met |
borderCrossings |
string |
Vermijdt grensovergangen in routeberekening. |
carpools |
string |
Vermijd routes die het gebruik van carpoolbanen (HOV/High Occupancy Vehicle) vereisen. |
ferries |
string |
Vermijd veerboten |
motorways |
string |
Vermijdt snelwegen |
tollRoads |
string |
Vermijd tolwegen. |
unpavedRoads |
string |
Vermijdt onverharde wegen |
RouteLegSummary
Overzichtsobject voor routesectie.
Name | Type | Description |
---|---|---|
arrivalTime |
string |
De geschatte aankomsttijd voor de route of het been. De tijd is in UTC. |
batteryConsumptionInkWh |
number |
Geschat energieverbruik in kilowatturen (kWh) met behulp van het elektrische verbruiksmodel. Inbegrepen als vehicleEngineType is ingesteld op elektrische en constantSpeedConsumptionInkWhPerHundredkm is opgegeven. De waarde van batteryConsumptionInkWh omvat de gerecupereerde elektrische energie en kan daarom negatief zijn (wat aangeeft dat energie wordt gewonnen). Als zowel maxChargeInkWh als currentChargeInkWh zijn opgegeven, wordt de recuperatie beperkt om ervoor te zorgen dat het oplaadniveau van de batterij nooit hoger is dan maxChargeInkWh. Als maxChargeInkWh of currentChargeInkWh niet zijn opgegeven, wordt niet-getrainde recuperatie verondersteld in de verbruiksberekening. |
departureTime |
string |
De geschatte vertrektijd voor de route of het been. De tijd is in UTC. |
fuelConsumptionInLiters |
number |
Geschat brandstofverbruik in liter met behulp van het verbrandingsverbruiksmodel. Inbegrepen als vehicleEngineType is ingesteld op verbranding en constantSpeedConsumptionInLitersPerHundredkm is opgegeven. De waarde is niet-negatief. |
historicTrafficTravelTimeInSeconds |
integer |
Geschatte reistijd berekend met tijdafhankelijke historische verkeersgegevens. Alleen opgenomen als computeTravelTimeFor = alles wordt gebruikt in de query. |
lengthInMeters |
integer |
Eigenschap Length In Meters |
liveTrafficIncidentsTravelTimeInSeconds |
integer |
Geschatte reistijd berekend met realtime snelheidsgegevens. Alleen opgenomen als computeTravelTimeFor = alles wordt gebruikt in de query. |
noTrafficTravelTimeInSeconds |
integer |
Geschatte reistijd berekend alsof er geen vertragingen op de route zijn vanwege verkeersomstandigheden (bijvoorbeeld congestie). Alleen opgenomen als computeTravelTimeFor = alles wordt gebruikt in de query. |
trafficDelayInSeconds |
integer |
Geschatte vertraging in seconden veroorzaakt door het realtime incident(en) op basis van verkeersinformatie. Voor routes gepland met vertrektijd in de toekomst is vertragingen altijd 0. Als u extra reistijden wilt retourneren met behulp van verschillende typen verkeersinformatie, moet u parameter computeTravelTimeFor=all toevoegen. |
travelTimeInSeconds |
integer |
Geschatte reistijd in seconden eigenschap met de vertraging als gevolg van realtime verkeer. Houd er rekening mee dat zelfs wanneer verkeer=false travelTimeInSeconds de vertraging als gevolg van verkeer nog steeds bevat. Als DepartAt zich in de toekomst bevindt, wordt reistijd berekend met tijdafhankelijke historische verkeersgegevens. |
RouteMatrix
Matrixresultaatobject
Name | Type | Description |
---|---|---|
response |
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 met coördinaten.
Name | Type | Description |
---|---|---|
destinations |
Een geldig |
|
origins |
Een geldig |
RouteMatrixResult
Dit object wordt geretourneerd door een geslaagde routematrix-aanroep. Als er bijvoorbeeld 2 oorsprongen en 3 bestemmingen worden opgegeven, worden er 2 matrices met 3 elementen in elk opgegeven. De inhoud van elk element is afhankelijk van de opties in de query.
Name | Type | Description |
---|---|---|
formatVersion |
string |
Eigenschap Versie opmaken |
matrix |
Resultaten als een tweedimensionale matrix van routeoverzichten. |
|
summary |
Samenvattingsobject |
RouteMatrixResultResponse
Antwoordobject van de huidige cel in de invoermatrix.
Name | Type | Description |
---|---|---|
routeSummary |
Overzichtsobject voor routesectie. |
RouteMatrixSummary
Samenvattingsobject
Name | Type | Description |
---|---|---|
successfulRoutes |
integer |
Aantal geslaagde routes in het antwoord. |
totalRoutes |
integer |
Het totale aantal aangevraagde routes. Aantal cellen in de invoermatrix. |
RouteType
Het type route aangevraagd.
Name | Type | Description |
---|---|---|
eco |
string |
Een route die in balans is met economie en snelheid. |
fastest |
string |
De snelste route. |
shortest |
string |
De kortste route op afstand. |
thrilling |
string |
Omvat interessante of uitdagende wegen en maakt gebruik van zo weinig mogelijk snelwegen. U kunt kiezen hoeveel bochten er zijn inbegrepen en ook de mate van heuvelachtigheid. Bekijk de heuvelachtige en wikkelingsparameters voor hoe u dit instelt. Er is een limiet van 900 km op routes gepland met |
SectionType
Hiermee geeft u op welke sectietypen worden gerapporteerd in het routeantwoord.
Als bijvoorbeeld sectionType = voetgangers de secties die alleen geschikt zijn voor voetgangers, worden geretourneerd. Kan meerdere keren worden opgegeven in één aanvraag, bijvoorbeeld '§ionType=carTrain§ionType=voetgangers§ionType=snelweg'. Het standaard sectionType verwijst naar de travelMode-invoer. Standaard is travelMode ingesteld op auto
Name | Type | Description |
---|---|---|
carTrain |
string |
Secties van de route die auto's of treinen zijn. |
carpool |
string |
Gedeelten van de route waarvoor het gebruik van carpoolbanen (HOV/High Occupancy Vehicle) nodig is. |
country |
string |
Secties die aangeven in welke landen/regio's de route zich bevindt. |
ferry |
string |
Secties van de route die veerboten zijn. |
motorway |
string |
Gedeelten van de route die snelwegen zijn. |
pedestrian |
string |
Gedeelten van de route die alleen geschikt zijn voor voetgangers. |
tollRoad |
string |
Secties van de route waarvoor een tol moet worden betaald. |
tollVignette |
string |
Gedeelten van de route waarvoor een tol vignet aanwezig moet zijn. |
traffic |
string |
Secties van de route die verkeersinformatie bevatten. |
travelMode |
string |
Secties met betrekking tot de aanvraagparameter |
tunnel |
string |
Secties van de route die tunnels zijn. |
urban |
string |
Gedeelten van de route die zich in stedelijke gebieden bevinden. |
TravelMode
De reismodus voor de aangevraagde route. Als dit niet is gedefinieerd, is de standaardwaarde 'auto'. Houd er rekening mee dat de aangevraagde travelMode mogelijk niet beschikbaar is voor de hele route. Wanneer de aangevraagde travelMode niet beschikbaar is voor een bepaalde sectie, is het element travelMode van het antwoord voor die sectie 'overig'. Houd er rekening mee dat reismodi bus, motorfiets, taxi en busje beta-functionaliteit zijn. Volledige beperkingsgegevens zijn niet beschikbaar in alle gebieden.
Name | Type | Description |
---|---|---|
bicycle |
string |
De geretourneerde routes zijn geoptimaliseerd voor fietsen, waaronder het gebruik van fietsbanen. |
bus |
string |
De geretourneerde routes zijn geoptimaliseerd voor bussen, inclusief het gebruik van alleen busbanen. BÈTA-functionaliteit. |
car |
string |
De geretourneerde routes zijn geoptimaliseerd voor auto's. |
motorcycle |
string |
De geretourneerde routes zijn geoptimaliseerd voor motorfietsen. BÈTA-functionaliteit. |
pedestrian |
string |
De geretourneerde routes zijn geoptimaliseerd voor voetgangers, waaronder het gebruik van stoeppaden. |
taxi |
string |
De geretourneerde routes zijn geoptimaliseerd voor taxi's. BÈTA-functionaliteit. |
truck |
string |
De geretourneerde routes zijn geoptimaliseerd voor bedrijfsvoertuigen, zoals voor vrachtwagens. |
van |
string |
De geretourneerde routes zijn geoptimaliseerd voor bestelwagens. BÈTA-functionaliteit. |
VehicleLoadType
Soorten ladingen die kunnen worden geclassificeerd als gevaarlijke materialen en beperkt zijn van sommige wegen. Beschikbare vehicleLoadType-waarden zijn US Hazmat-klassen 1 tot en met 9, plus algemene classificaties voor gebruik in andere landen/regio's. Waarden die beginnen met USHazmat zijn voor amerikaanse routering, terwijl andereHazmat moet worden gebruikt voor alle andere landen/regio's. vehicleLoadType kan meerdere keren worden opgegeven. Deze parameter wordt momenteel alleen in aanmerking genomen voor travelMode=truck.
Name | Type | Description |
---|---|---|
USHazmatClass1 |
string |
Explosieven |
USHazmatClass2 |
string |
Gecomprimeerd gas |
USHazmatClass3 |
string |
Brandbare vloeistoffen |
USHazmatClass4 |
string |
Brandbare vaste stoffen |
USHazmatClass5 |
string |
Oxidizers |
USHazmatClass6 |
string |
Vergif |
USHazmatClass7 |
string |
Radioactief |
USHazmatClass8 |
string |
Corrosieven |
USHazmatClass9 |
string |
Allerlei |
otherHazmatExplosive |
string |
Explosieven |
otherHazmatGeneral |
string |
Allerlei |
otherHazmatHarmfulToWater |
string |
Schadelijk voor water |
WindingnessLevel
Hoogte van bochten voor spannende route. Deze parameter kan alleen worden gebruikt in combinatie met routeType
=spannende.
Name | Type | Description |
---|---|---|
high |
string |
hoog |
low |
string |
laag |
normal |
string |
normaal |