GetRoute

説明

GetRoute サービスは、2 つのポイントまたは複数のポイントに対するルーティング情報を返します。始点および終点とオプションで通過点を入力として取り、最短時間または最短距離となるルートを返します。

HTTP GET URL 形式

HTTP GET 要求には次の形式を使用します。HTTP GET は、その他の JSON ペイロードを必要としない単純なルートに使用します。HTTP GET 要求に通過点を追加することもできます。

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

ここで、dbsource は、ルート用のデータを含むデータベースの名前です。Spatial モジュールのルーティング データベース リソース ツールで指定されたデータベース名を使用してください。

HTTP POST URL 形式

HTTP POST リクエストには次の形式を使用します。

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

Route Data は、通過点、一時更新、または道路タイプの優先度を含む計算で使用されるその他のルート情報を表す POST Json 本体 (Content-Type: application/json) です。これらのオプションの詳細については、GetRoute HTTP POST オプション を参照してください。

クエリ パラメータ

この演算は、次のクエリ パラメータを取ります。

例

始点と終点を持つ単純なルート。

http://www.pb.com/rest/Spatial/erm/databases/usroutedatabase.json?q=route&startPoint=-73.97,40.79,epsg:4326&endPoint=-73.98,40.74,epsg:4326			
			

応答

			
{
	"distance": 7779,
	"distanceUnit": "m",
	"time": 16.75,
	"timeUnit": "min"
}			

通過点を持つルート。

http://www.pb.com/rest/Spatial/erm/databases/usroutedatabase.json?q=route&
				startPoint=-73.970257,40.794045,epsg:4326&endPoint=-
				73.972103,40.786605,epsg:4326&intermediatePoints=-73.976266,40.788717,
				-73.973562,40.792193,-73.971802,40.794630,epsg:4326&oip=true&
				returnIntermediatePoints=true"/>

応答

				{
				"distance": 1921,
				"distanceUnit": "m",
				"intermediatePoints": {
				"type": "MultiPoint",
				"coordinates": [
				[-73.971802, 40.79463],
				[-73.973562, 40.792193],
				[-73.976266, 40.788717]
				]
				},
				"time": 4.2,
				"timeUnit": "min"
				}

道順が有効になっているルート。

http://www.pb.com/rest/Spatial/erm/databases/usroutedatabase.json?q=route&startPoint=-73.97,40.79,epsg:4326&endPoint=-73.98,40.74,
epsg:4326&language=en&directionsStyle=Normal&returnDirectionGeometry=true

応答

{
"time": 10.58,
"timeUnit": "min",
"distance": 9035,
"distanceUnit": "m",
"language": "en",
"directionsStyle": "Normal",
"routeDirections": [
{
"time": 0.03,
"timeUnit": "min",
"distance": 25,
"distanceUnit": "m",
"instruction": "",
"directionGeometry":
{
"type": "LineString",
"coordinates":
[
[
-76.421169,
42.69302
],
[
-76.421353,
42.692645
],
...
]
}
},
{
"time": 0.7,
"timeUnit": "min",
"distance": 394,
"distanceUnit": "m",
"instruction": "Turn right on W 91st St and travel West 394.0 m
(0.7 min).",
"directionGeometry":
{
"type": "LineString",
"coordinates":
[
[
-76.429896,
42.67153
],
...
]
}
}
]
}

バージョン固有のエラー応答

リクエストに無効なパラメータ値 (ポイントが境界の外側にある、など) を入力すると、入力したバージョンによって異なるエラー応答が返ります。バージョンが 1 の場合、値とエラーが返りますが、バージョンが 2 の場合、応答にはエラーのみが含まれます。

• version が 1 の場合のリクエスト:

  http://www.pb.com/rest/Spatial/erm/databases/usroutedatabase.json?
  &q=route&startPoint=-14.321600,60.662859,epsg:4326&endPoint=-74.035208,40.695624,
  epsg:4326&distanceUnit=km&version=1  

• レスポンス:

  {
    "value": "Point outside boundaries: (-14.3216,60.662859,0)",
    "errors": [
      {
        "errorCode": 5008,
        "userMessage": "Point outside boundaries: (-14.3216,60.662859,0)"
      }
    ]
  }

• version が 2 の場合のリクエスト:

  http://www.pb.com/rest/Spatial/erm/databases/usroutedatabase.json?
  &q=route&startPoint=-14.321600,60.662859,epsg:4326&endPoint=-74.035208,40.695624,
  epsg:4326&distanceUnit=km&version=2 

• レスポンス:

  {
    "errors": [
      {
        "errorCode": 5008,
        "userMessage": "Point outside boundaries: (-14.3216,60.662859,0)"
      }
    ]
  }