Partager via

RouteRequestRouteMatrixQueryParamProperties interface

  • Référence
Paquet:
@azure-rest/maps-route

Propriétés

arriveAt

Date et heure d’arrivée au point de destination mis en forme sous la forme d’une valeur dateTime définie dans RFC 3339, section 5.6, avec un décalage de fuseau horaire facultatif. Lorsqu’un décalage de fuseau horaire n’est pas spécifié, il est supposé être celui du point de destination.

Exemples :

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

Le paramètre arriveAt ne peut pas être utilisé conjointement avec departAt, minDeviationDistance ou minDeviationTime.
avoid

Spécifie un élément que le calcul de l’itinéraire doit essayer d’éviter lors de la détermination de l’itinéraire. Peut être spécifié plusieurs fois dans une requête, par exemple , '&avoid=autoroutes&avoid=tollRoads&avoid=ferries'. Dans les requêtes de plage d’itinéraires, la valeur déjàUsedRoads ne doit pas être utilisée.
computeTravelTimeFor

Spécifie s’il faut retourner des temps de voyage supplémentaires à l’aide de différents types d’informations sur le trafic (aucun, historique, live) ainsi que le temps de voyage par défaut le mieux estimé.
departAt

Date et heure de départ du point d’origine mis en forme comme valeur dateTime définie dans RFC 3339, section 5.6, avec un décalage de fuseau horaire facultatif. Lorsqu’un décalage de fuseau horaire n’est pas spécifié, il est supposé être celui du point d’origine.

  • Valeur par défaut : maintenant
  • Autre valeur : dateTime

Exemples :

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

Le paramètre departAt ne peut pas être utilisé conjointement avec arriveAt.
hilliness

Degré de colline pour la route excitante. Ce paramètre ne peut être utilisé que conjointement avec routeType=thrilling.
routeType

Type d’itinéraire demandé.
sectionType

Spécifie quels types de sections sont signalés dans la réponse de routage.

Par exemple, si sectionType = piéton les sections qui conviennent uniquement aux piétons sont retournées. Peut être spécifié plusieurs fois dans une requête, par exemple , '§ionType=carTrain§ionType=piéton§ionType=autoroute'. La sectionType par défaut fait référence à l’entrée travelMode. Par défaut, travelMode est défini sur voiture
traffic

Valeurs possibles :

  • true : tenez compte de toutes les informations de trafic disponibles pendant le routage
  • false : ignorez les données de trafic actuelles pendant le routage. Notez que bien que les données actuelles sur le trafic soient ignorées pendant le routage, l’effet du trafic historique sur les vitesses de route effectives est toujours incorporé.
travelMode

Mode de voyage pour l’itinéraire demandé. S’il n’est pas défini, la valeur par défaut est « car ». Notez que le travelMode demandé peut ne pas être disponible pour l’intégralité de l’itinéraire. Lorsque le travelMode demandé n’est pas disponible pour une section particulière, l’élément travelMode de la réponse de cette section sera « autre ». Notez que les modes de voyage bus, moto, taxi et van sont des fonctionnalités BÊTA. Les données de restriction complètes ne sont pas disponibles dans toutes les zones.
vehicleAxleWeight

Poids par axe du véhicule en kg. La valeur 0 signifie que les restrictions de poids par axe ne sont pas prises en compte.
vehicleHeight

Hauteur du véhicule en mètres. La valeur 0 signifie que les restrictions de hauteur ne sont pas prises en compte.
vehicleLength

Longueur du véhicule en mètres. La valeur 0 signifie que les restrictions de longueur ne sont pas prises en compte.
vehicleLoadType

Types de cargaisons pouvant être classifiées comme matières dangereuses et restreintes à partir de certaines routes. Les valeurs vehicleLoadType disponibles sont les classes hazmat américaines 1 à 9, ainsi que les classifications génériques à utiliser dans d’autres pays/régions. Les valeurs commençant par USHazmat sont destinées au routage américain, tandis que d’autresHazmat doivent être utilisées pour tous les autres pays/régions. vehicleLoadType peut être spécifié plusieurs fois. Ce paramètre est actuellement pris en compte uniquement pour travelMode=truck.
vehicleMaxSpeed

Vitesse maximale du véhicule en km/heure. La vitesse maximale dans le profil du véhicule est utilisée pour vérifier si un véhicule est autorisé sur les autoroutes.

  • La valeur 0 signifie qu’une valeur appropriée pour le véhicule sera déterminée et appliquée pendant la planification de l’itinéraire.

  • Une valeur non nulle peut être remplacée pendant la planification de l’itinéraire. Par exemple, le flux de trafic actuel est de 60 km/heure. Si la vitesse maximale du véhicule est définie sur 50 km/heure, le moteur de routage prend en compte 60 km/heure, car il s’agit de la situation actuelle. Si la vitesse maximale du véhicule est fournie comme étant de 80 km/heure, mais que le trafic actuel est de 60 km/heure, le moteur de routage utilise à nouveau 60 km/heure.
vehicleWeight

Poids du véhicule en kilos.
vehicleWidth

Largeur du véhicule en mètres. La valeur 0 signifie que les restrictions de largeur ne sont pas prises en compte.
waitForResults

Boolean pour indiquer s’il faut exécuter la requête de façon synchrone. Si la valeur est true, l’utilisateur obtient une réponse 200 si la demande est terminée sous 120 secondes. Sinon, l’utilisateur obtient immédiatement une réponse 202. Pour plus d’informations sur la réponse 202, reportez-vous à la description de l’API. pris en charge uniquement pour lesde requête asynchrone .
windingness

Niveau de virages pour la route excitante. Ce paramètre ne peut être utilisé que conjointement avec routeType=thrilling.

Détails de la propriété

arriveAt

Date et heure d’arrivée au point de destination mis en forme sous la forme d’une valeur dateTime définie dans RFC 3339, section 5.6, avec un décalage de fuseau horaire facultatif. Lorsqu’un décalage de fuseau horaire n’est pas spécifié, il est supposé être celui du point de destination.

Exemples :

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

Le paramètre arriveAt ne peut pas être utilisé conjointement avec departAt, minDeviationDistance ou minDeviationTime.

arriveAt?: string | Date

Valeur de propriété

string | Date

avoid

Spécifie un élément que le calcul de l’itinéraire doit essayer d’éviter lors de la détermination de l’itinéraire. Peut être spécifié plusieurs fois dans une requête, par exemple , '&avoid=autoroutes&avoid=tollRoads&avoid=ferries'. Dans les requêtes de plage d’itinéraires, la valeur déjàUsedRoads ne doit pas être utilisée.

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

Valeur de propriété

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

computeTravelTimeFor

Spécifie s’il faut retourner des temps de voyage supplémentaires à l’aide de différents types d’informations sur le trafic (aucun, historique, live) ainsi que le temps de voyage par défaut le mieux estimé.

computeTravelTimeFor?: "none" | "all"

Valeur de propriété

"none" | "all"

departAt

Date et heure de départ du point d’origine mis en forme comme valeur dateTime définie dans RFC 3339, section 5.6, avec un décalage de fuseau horaire facultatif. Lorsqu’un décalage de fuseau horaire n’est pas spécifié, il est supposé être celui du point d’origine.

  • Valeur par défaut : maintenant
  • Autre valeur : dateTime

Exemples :

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

Le paramètre departAt ne peut pas être utilisé conjointement avec arriveAt.

departAt?: string | Date

Valeur de propriété

string | Date

hilliness

Degré de colline pour la route excitante. Ce paramètre ne peut être utilisé que conjointement avec routeType=thrilling.

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

Valeur de propriété

"low" | "normal" | "high"

routeType

Type d’itinéraire demandé.

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

Valeur de propriété

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

sectionType

Spécifie quels types de sections sont signalés dans la réponse de routage.

Par exemple, si sectionType = piéton les sections qui conviennent uniquement aux piétons sont retournées. Peut être spécifié plusieurs fois dans une requête, par exemple , '§ionType=carTrain§ionType=piéton§ionType=autoroute'. La sectionType par défaut fait référence à l’entrée travelMode. Par défaut, travelMode est défini sur voiture

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

Valeur de propriété

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

traffic

Valeurs possibles :

  • true : tenez compte de toutes les informations de trafic disponibles pendant le routage
  • false : ignorez les données de trafic actuelles pendant le routage. Notez que bien que les données actuelles sur le trafic soient ignorées pendant le routage, l’effet du trafic historique sur les vitesses de route effectives est toujours incorporé.
traffic?: boolean

Valeur de propriété

boolean

travelMode

Mode de voyage pour l’itinéraire demandé. S’il n’est pas défini, la valeur par défaut est « car ». Notez que le travelMode demandé peut ne pas être disponible pour l’intégralité de l’itinéraire. Lorsque le travelMode demandé n’est pas disponible pour une section particulière, l’élément travelMode de la réponse de cette section sera « autre ». Notez que les modes de voyage bus, moto, taxi et van sont des fonctionnalités BÊTA. Les données de restriction complètes ne sont pas disponibles dans toutes les zones.

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

Valeur de propriété

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

vehicleAxleWeight

Poids par axe du véhicule en kg. La valeur 0 signifie que les restrictions de poids par axe ne sont pas prises en compte.

vehicleAxleWeight?: number

Valeur de propriété

number

vehicleHeight

Hauteur du véhicule en mètres. La valeur 0 signifie que les restrictions de hauteur ne sont pas prises en compte.

vehicleHeight?: number

Valeur de propriété

number

vehicleLength

Longueur du véhicule en mètres. La valeur 0 signifie que les restrictions de longueur ne sont pas prises en compte.

vehicleLength?: number

Valeur de propriété

number

vehicleLoadType

Types de cargaisons pouvant être classifiées comme matières dangereuses et restreintes à partir de certaines routes. Les valeurs vehicleLoadType disponibles sont les classes hazmat américaines 1 à 9, ainsi que les classifications génériques à utiliser dans d’autres pays/régions. Les valeurs commençant par USHazmat sont destinées au routage américain, tandis que d’autresHazmat doivent être utilisées pour tous les autres pays/régions. vehicleLoadType peut être spécifié plusieurs fois. Ce paramètre est actuellement pris en compte uniquement pour travelMode=truck.

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

Valeur de propriété

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

vehicleMaxSpeed

Vitesse maximale du véhicule en km/heure. La vitesse maximale dans le profil du véhicule est utilisée pour vérifier si un véhicule est autorisé sur les autoroutes.

  • La valeur 0 signifie qu’une valeur appropriée pour le véhicule sera déterminée et appliquée pendant la planification de l’itinéraire.

  • Une valeur non nulle peut être remplacée pendant la planification de l’itinéraire. Par exemple, le flux de trafic actuel est de 60 km/heure. Si la vitesse maximale du véhicule est définie sur 50 km/heure, le moteur de routage prend en compte 60 km/heure, car il s’agit de la situation actuelle. Si la vitesse maximale du véhicule est fournie comme étant de 80 km/heure, mais que le trafic actuel est de 60 km/heure, le moteur de routage utilise à nouveau 60 km/heure.

vehicleMaxSpeed?: number

Valeur de propriété

number

vehicleWeight

Poids du véhicule en kilos.

vehicleWeight?: number

Valeur de propriété

number

vehicleWidth

Largeur du véhicule en mètres. La valeur 0 signifie que les restrictions de largeur ne sont pas prises en compte.

vehicleWidth?: number

Valeur de propriété

number

waitForResults

Boolean pour indiquer s’il faut exécuter la requête de façon synchrone. Si la valeur est true, l’utilisateur obtient une réponse 200 si la demande est terminée sous 120 secondes. Sinon, l’utilisateur obtient immédiatement une réponse 202. Pour plus d’informations sur la réponse 202, reportez-vous à la description de l’API. pris en charge uniquement pour lesde requête asynchrone .

waitForResults?: boolean

Valeur de propriété

boolean

windingness

Niveau de virages pour la route excitante. Ce paramètre ne peut être utilisé que conjointement avec routeType=thrilling.

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

Valeur de propriété

"low" | "normal" | "high"