Delen via

RouteRequestRouteMatrixSyncQueryParamProperties interface

  • Referentie
Pakket:
@azure-rest/maps-route

Eigenschappen

arriveAt

De datum en tijd van aankomst op het doelpunt dat is opgemaakt als een dateTime-waarde zoals gedefinieerd in RFC 3339, sectie 5,6, met een optionele tijdzone-offset. Wanneer er geen tijdzone-offset wordt opgegeven, wordt ervan uitgegaan dat dit van het doelpunt is.

Voorbeelden:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

De parameter arriveAt kan niet worden gebruikt in combinatie met departAt, minDeviationDistance of minDeviationTime.
avoid

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

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

De datum en tijd van vertrek van het oorspronkelijke punt die zijn opgemaakt als een dateTime waarde zoals gedefinieerd in RFC 3339, sectie 5,6, met een optionele tijdzone-offset. Wanneer er geen tijdzone-offset is opgegeven, wordt ervan uitgegaan dat deze van het oorspronkelijke punt is.

  • Standaardwaarde: nu
  • Andere waarde: dateTime

Voorbeelden:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

De parameter departAt kan niet worden gebruikt in combinatie met arriveAt.
hilliness

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

Het type route aangevraagd.
sectionType

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

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

Mogelijke waarden:

  • true - Houd rekening met alle beschikbare verkeersinformatie tijdens routering
  • false : huidige verkeersgegevens tijdens routering negeren. Houd er rekening mee dat hoewel de huidige verkeersgegevens tijdens de routering worden genegeerd, het effect van historisch verkeer op effectieve wegsnelheden nog steeds wordt opgenomen.
travelMode

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

Gewicht per as van het voertuig in kg. Een waarde van 0 betekent dat gewichtsbeperkingen per as niet worden overwogen.
vehicleHeight

Hoogte van het voertuig in meters. Een waarde van 0 betekent dat hoogtebeperkingen niet worden overwogen.
vehicleLength

Lengte van het voertuig in meters. Een waarde van 0 betekent dat lengtebeperkingen niet worden overwogen.
vehicleLoadType

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

Maximumsnelheid van het voertuig in km/uur. De maximale snelheid in het voertuigprofiel wordt gebruikt om te controleren of een voertuig is toegestaan op snelwegen.

  • Een waarde van 0 betekent dat een passende waarde voor het voertuig wordt bepaald en toegepast tijdens de routeplanning.

  • Een niet-nulwaarde kan tijdens het plannen van de route worden overschreven. De huidige verkeersstroom is bijvoorbeeld 60 km/uur. Als de maximumsnelheid van het voertuig is ingesteld op 50 km/uur, zal de routeringsmotor rekening houden met 60 km/uur, aangezien dit de huidige situatie is. Als de maximumsnelheid van het voertuig wordt opgegeven als 80 km/uur, maar de huidige verkeersstroom 60 km/uur is, gebruikt de routeringsmotor opnieuw 60 km/uur.
vehicleWeight

Gewicht van het voertuig in kilogram.
vehicleWidth

Breedte van het voertuig in meters. Een waarde van 0 betekent dat breedtebeperkingen niet worden overwogen.
waitForResults

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

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

Eigenschapdetails

arriveAt

De datum en tijd van aankomst op het doelpunt dat is opgemaakt als een dateTime-waarde zoals gedefinieerd in RFC 3339, sectie 5,6, met een optionele tijdzone-offset. Wanneer er geen tijdzone-offset wordt opgegeven, wordt ervan uitgegaan dat dit van het doelpunt is.

Voorbeelden:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

De parameter arriveAt kan niet worden gebruikt in combinatie met departAt, minDeviationDistance of minDeviationTime.

arriveAt?: string | Date

Waarde van eigenschap

string | Date

avoid

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.

avoid?: ("tollRoads" | "motorways" | "ferries" | "unpavedRoads" | "carpools" | "alreadyUsedRoads" | "borderCrossings")[]

Waarde van eigenschap

("tollRoads" | "motorways" | "ferries" | "unpavedRoads" | "carpools" | "alreadyUsedRoads" | "borderCrossings")[]

computeTravelTimeFor

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.

computeTravelTimeFor?: "none" | "all"

Waarde van eigenschap

"none" | "all"

departAt

De datum en tijd van vertrek van het oorspronkelijke punt die zijn opgemaakt als een dateTime waarde zoals gedefinieerd in RFC 3339, sectie 5,6, met een optionele tijdzone-offset. Wanneer er geen tijdzone-offset is opgegeven, wordt ervan uitgegaan dat deze van het oorspronkelijke punt is.

  • Standaardwaarde: nu
  • Andere waarde: dateTime

Voorbeelden:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

De parameter departAt kan niet worden gebruikt in combinatie met arriveAt.

departAt?: string | Date

Waarde van eigenschap

string | Date

hilliness

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

hilliness?: "low" | "normal" | "high"

Waarde van eigenschap

"low" | "normal" | "high"

routeType

Het type route aangevraagd.

routeType?: "fastest" | "shortest" | "eco" | "thrilling"

Waarde van eigenschap

"fastest" | "shortest" | "eco" | "thrilling"

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

sectionType?: ("carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban")[]

Waarde van eigenschap

("carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban")[]

traffic

Mogelijke waarden:

  • true - Houd rekening met alle beschikbare verkeersinformatie tijdens routering
  • false : huidige verkeersgegevens tijdens routering negeren. Houd er rekening mee dat hoewel de huidige verkeersgegevens tijdens de routering worden genegeerd, het effect van historisch verkeer op effectieve wegsnelheden nog steeds wordt opgenomen.
traffic?: boolean

Waarde van eigenschap

boolean

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.

travelMode?: "pedestrian" | "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle"

Waarde van eigenschap

"pedestrian" | "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle"

vehicleAxleWeight

Gewicht per as van het voertuig in kg. Een waarde van 0 betekent dat gewichtsbeperkingen per as niet worden overwogen.

vehicleAxleWeight?: number

Waarde van eigenschap

number

vehicleHeight

Hoogte van het voertuig in meters. Een waarde van 0 betekent dat hoogtebeperkingen niet worden overwogen.

vehicleHeight?: number

Waarde van eigenschap

number

vehicleLength

Lengte van het voertuig in meters. Een waarde van 0 betekent dat lengtebeperkingen niet worden overwogen.

vehicleLength?: number

Waarde van eigenschap

number

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.

vehicleLoadType?: "USHazmatClass1" | "USHazmatClass2" | "USHazmatClass3" | "USHazmatClass4" | "USHazmatClass5" | "USHazmatClass6" | "USHazmatClass7" | "USHazmatClass8" | "USHazmatClass9" | "otherHazmatExplosive" | "otherHazmatGeneral" | "otherHazmatHarmfulToWater"

Waarde van eigenschap

"USHazmatClass1" | "USHazmatClass2" | "USHazmatClass3" | "USHazmatClass4" | "USHazmatClass5" | "USHazmatClass6" | "USHazmatClass7" | "USHazmatClass8" | "USHazmatClass9" | "otherHazmatExplosive" | "otherHazmatGeneral" | "otherHazmatHarmfulToWater"

vehicleMaxSpeed

Maximumsnelheid van het voertuig in km/uur. De maximale snelheid in het voertuigprofiel wordt gebruikt om te controleren of een voertuig is toegestaan op snelwegen.

  • Een waarde van 0 betekent dat een passende waarde voor het voertuig wordt bepaald en toegepast tijdens de routeplanning.

  • Een niet-nulwaarde kan tijdens het plannen van de route worden overschreven. De huidige verkeersstroom is bijvoorbeeld 60 km/uur. Als de maximumsnelheid van het voertuig is ingesteld op 50 km/uur, zal de routeringsmotor rekening houden met 60 km/uur, aangezien dit de huidige situatie is. Als de maximumsnelheid van het voertuig wordt opgegeven als 80 km/uur, maar de huidige verkeersstroom 60 km/uur is, gebruikt de routeringsmotor opnieuw 60 km/uur.

vehicleMaxSpeed?: number

Waarde van eigenschap

number

vehicleWeight

Gewicht van het voertuig in kilogram.

vehicleWeight?: number

Waarde van eigenschap

number

vehicleWidth

Breedte van het voertuig in meters. Een waarde van 0 betekent dat breedtebeperkingen niet worden overwogen.

vehicleWidth?: number

Waarde van eigenschap

number

waitForResults

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.

waitForResults?: boolean

Waarde van eigenschap

boolean

windingness

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

windingness?: "low" | "normal" | "high"

Waarde van eigenschap

"low" | "normal" | "high"