GetTravelBoundary

Description

GetTravelBoundary détermine une limite de distance ou de temps de marche ou de conduite en voiture à partir d'un lieu. Cette fonctionnalité obtient des polygones correspondant à un calcul d'isochrone ou d'isodistance. Un isochrone est un polygone ou ensemble de points représentant une zone pouvant être traversée à partir d'un point de départ en un temps donné via un réseau routier. Un isodistance est un polygone ou ensemble de points représentant la zone située à une certaine distance par rapport à un point de départ. L'opération GetTravelBoundary (également appelée définition iso) prend comme entrée un point de départ, une unité (linéaire ou temporelle) et un ou plusieurs coûts et renvoie la limite de trajet à parcourir obtenue. Le coût fait référence au temps ou à la distance à utiliser pour calculer un iso. Il est également possible de fournir plusieurs coûts en entrée. En cas de fourniture de plusieurs coûts, ceux-ci peuvent être fournis sous forme de chaîne délimitée par des virgules.

Remarque : La réponse du service REST se présente au format JSON. Lorsqu'une requête contient des paramètres de requête non valides dans l'URL GET, ou une charge utile non valide pour POST, une réponse d’erreurs cumulées est renvoyée dans un tableau JSON. Le nœud value de la réponse JSON est déprécié. Pour la vérification des erreurs, seul le nœud errors doit être utilisé.

Format d'URL GET HTTP

Les requêtes GET HTTP se présentent au format suivant : Les requêtes GET HTTP sont utilisées pour toutes les limites de trajet qui ne requièrent pas de charge utile JSON supplémentaire (modifications de la vitesse hors route).


HTTP GET /rest/Spatial/erm/databases/dbsource.json?q=travelBoundary&query_parameters

Où dbsource est le nom de la base de données contenant les données à utiliser pour l'itinéraire. Utilisez le nom de base de données indiqué dans l'outil de ressource de base de données de routage du module Enterprise Routing.

Format d'URL POST HTTP

Les requêtes POST HTTP se présentent au format suivant :


HTTP POST:  /rest/Spatial/erm/databases/dbsource.json?q=travelBoundary&query_parameters
POST BODY: Content-Type:application/json {Route Data}

Route Data est le corps json POST (type de contenu : application/json) des indications d'itinéraire supplémentaires à utiliser dans le calcul contenant des vitesses hors route pour les types de route. Pour plus d'informations sur ces options ainsi que des exemples, reportez-vous à la section Options GetTravelBoundary POST HTTP.

Paramètres de requête

Cette opération prend les paramètres de requête suivants.

Paramètre	Type	Obligatoire	Description
`point`	Chaîne	oui	Lieu de départ à partir duquel calculer la limite de trajet au format : x,y,coordSys. Par exemple : -74.2,40.8,epsg:4326
`costs`	Double	oui	Coûts de distance ou de temps, dans les unités de coût indiquées. Par exemple, si les unités indiquées sont les miles et si vous indiquez 10 dans ce paramètre, la limite de trajet est calculée pour 10 miles. Vous pouvez également indiquer plusieurs coûts en précisant les valeurs sous forme de chaîne délimitée par des virgules. Cette chaîne renvoie une limite de trajet distincte pour chaque coût indiqué. Si vous indiquez plusieurs coûts, chaque réponse comporte un coût et des unités de coût associés.
`costUnit`	Chaîne	oui	Type de mesure utilisé pour calculer la limite de trajet. Les valeurs de distance disponibles sont les suivantes : m (mètre), km (kilomètre), yd (yard), ft (pied) et mi (mile). Les valeurs de temps disponibles sont les suivantes : min (minute), msec (milliseconde), s (seconde), h (heure).
`maxOffroadDistance`	Double	non	Distance maximale de trajet autorisée hors du réseau routier via `maxOffroadDistanceUnit`. Les allées et les bretelles d'accès sont des exemples de routes en dehors du réseau routier. Par exemple, si vous spécifiez une distance maximale hors du réseau routier d'1 mile (1609 mètres), la limite de chemin à parcourir ne sortira pas de plus d'1 mile du réseau routier. Si vous spécifiez une valeur de 0, la limite de chemin à parcourir ne sortira pas du réseau routier. Utilisez les options de vitesse ambiante pour spécifier la vitesse d'acheminement le long des routes hors réseau routier.
`maxOffroadDistanceUnit`	Chaîne	non	Unité de distance définissant `maxOffroadDistance`. Si vous définissez ce paramètre, vous devez également définir maxOffroadDistance. Les valeurs de distance disponibles sont les suivantes : m (mètre), km (kilomètre), yd (yard), ft (pied) et mi (mile).
`destinationSrs`	Chaîne	non	Système de coordonnées dans lequel renvoyer les géométries de limite de trajet. Le système de coordonnées par défaut est celui des données utilisées (par exemple, epsg:4326).
`majorRoads`	Booléen	non	Spécifie s'il faut inclure toutes les routes dans le calcul ou seulement les routes principales. Si vous choisissez d'inclure uniquement les routes principales, la performance sera améliorée mais la précision en pâtira peut-être. La valeur par défaut est true.
`returnHoles`	Booléen	non	Spécifie si vous voulez renvoyer des trous, c'est-à-dire des zones à l'intérieur de la limite plus grande qui ne peuvent être atteintes dans les limites de temps et de distance, en fonction du réseau routier. La valeur par défaut est false.
`returnIslands`	Booléen	non	Indique si vous souhaitez ou non renvoyer des îles, à savoir de petites zones en dehors de la limite principale accessibles dans le temps ou la distance souhaités. La valeur par défaut est false.
`simplificationFactor`	Entier	non	Spécifie le pourcentage des points d'origine à renvoyer ou sur lequel baser la complexité des géométries obtenue. Un nombre compris entre 0.0 et 1.0 est accepté, à l’exclusion de 0.0, mais avec 1.0 inclus. La complexité augmente à mesure que la valeur augmente, par conséquent 1.0 signifie le plus complexe. La valeur par défaut est 0.5.
`bandingStyle`	Chaîne	non	Spécifie le style de tranche à utiliser dans le résultat. Les styles de tranche sont les types de différentes tranches de distances pouvant être affichées en fonction de plusieurs coûts. Les styles de tranche peuvent être renvoyés aux formats suivants : Donut Chaque limite est déterminée en soustrayant la prochaine plus petite limite. Il s'agit de la méthode par défaut. Encompassing Chaque limite est déterminée indépendante des autres.
`historicTrafficTimeBucket`	Chaîne	non	Spécifie si le calcul de l'itinéraire utilise les vitesses de circulation historiques. Ces vitesses sont basées sur différents compartiments de temps de la journée. Pour que cette fonction soit disponible, il faut que les données comportent l'historique des vitesses de circulation. Les données de chaque pays/région possèdent les mêmes définitions de tranches horaires mais les valeurs de vitesses par tranches horaires peuvent varier. Les options sont : None Valeur par défaut. Les données d'historiques de circulation ne sont pas utilisées dans le calcul. À leur place, une valeur de vitesse moyenne est utilisée. AMPeak Calculez des itinéraires à l'aide des vitesses de pointe le matin. La tranche horaire Heures pleines matin se situe entre 07 h 00 et 10 h 00. PMPeak Calculez des itinéraires à l'aide des vitesses de pointe l'après-midi. La tranche horaire Heures pleines après-midi se situe entre 16 h 00 et 19 h 00. OffPeak Calculez des itinéraires à l'aide des vitesses aux heures creuses de la journée. La tranche horaire Heures creuses se situe entre 10 h 00 et 16 h 00. Night Calculez des itinéraires à l'aide des vitesses de nuit. La tranche horaire Nuit se situe 22 h 00 de 04 h 00.
`defaultAmbientSpeed`	Chaîne	non	Vitesse de trajet lorsqu'on quitte la route du réseau pour trouver la limite de trajet (pour tous les types de route). Pour contrôler la manière dont un trajet hors réseau est utilisé dans le calcul des limites du chemin à parcourir, vous devez indiquer la vitesse d'acheminement en dehors du réseau routier (la vitesse ambiante). La vitesse ambiante peut affecter la taille et la forme d'un polygone de limites du chemin à parcourir. En général, plus la vitesse ambiante est élevée, plus grand est polygone. Par exemple, si vous vous trouvez à un point avec 5 minutes restantes, et si la vitesse ambiante est 15 miles/heure (soit 24,14 km/h), les points limites seraient placés à une distance de 1,25 miles (2,01 km). Si la vitesse ambiante était réduite à 10 miles/heure (16,09 km), les points limites seraient placés à une distance de 0,83 miles (soit 1,33 km). Remarque : La valeur par défaut de defaultAmbientSpeed est 15.
`ambientSpeedUnit`	Chaîne	non	Unité de mesure à utiliser pour calculer la vitesse hors route. Les unités de vitesse disponibles sont les suivantes : MPH (miles par heure), KPH (kilomètres par heure), MTPS (mètres par seconde) et MTPM (mètres par minute). Remarque : La valeur par défaut de ambientSpeedUnit est MPH.

Exemples

Limite de trajet avec un seul coût.


http://www.pb.com/rest/Spatial/erm/databases/usroutedatabase.json?q=travelBoundary&point=-77.092609,38.871256,epsg:4326&costs=5&costUnit=m

Réponse


{
"travelBoundary": {
  "costs": [
	{
		"cost": 5,
		"costUnit": "m",
		"geometry": {"type":"MultiPolygon","coordinates":[[[...]]]}
	}
  ]
}
}

Limite de trajet avec plusieurs coûts.


http://www.pb.com/rest/Spatial/erm/databases/usroutedatabase.json?q=travelBoundary&point=-77.092609,38.871256,epsg:4326&costs=2,5&costUnit=m

Réponse


{
"travelBoundary": {
  "costs": [
	    {
                 "cost": 2,
                 "costUnit": "m",
		"geometry": "{"type":"MultiPolygon","coordinates":[[[...]]]}"
	},
	{
		"cost": 5,
		"costUnit": "m",
		"geometry": "{"type":"MultiPolygon","coordinates":[[[...]]]}"
	}
  ]
}
}
}