到達圏探索(徒歩)
/reachable_walk [GET]
基本情報
概要
徒歩を移動手段として、指定した地点から指定した時間または距離で到達可能な地点を探索します。
URL
https://{HOST}/{CID}/v1/reachable_walk
※APIマーケットの場合はURL体系が異なります
出力形式
- JSON
対応言語
- ja
出力順
- 所要時間の昇順
パラメータ
| パラメータ名 | 必須 | 概要 | 型名 | デフォルト値 | 上下限/選択値 | 備考 |
|---|---|---|---|---|---|---|
| start | ✔ | 出発地点 | ・カンマ区切りの数値(緯度, 経度) ・文字列(ノードID) |
|||
| term | (✔) | 探索時間の範囲(単位:分) | 数値 | 最小値:1 最大値:180 |
termまたはrangeのどちらかを必ず指定してください | |
| range | (✔) | 探索距離の範囲(単位:m) | 数値 | 最小値:1 最大値:10000 |
termまたはrangeのどちらかを必ず指定してください | |
| partition_count | 到達圏探索の分割数 | 数値 | 36 | 下記のいずれか 3,4,6,9,12,18, 36,40,45,60,72,90 |
360度の探索範囲を何分割するかを指定します 36で指定した場合は10度ずつ進行方向が区切られ、計36地点が算出されます |
|
| walk_speed | 徒歩の速度(単位:km/h) | 数値 | 4.8 | 最小値:3.0 最大値:8.0 |
小数値は第一位まで有効です | |
| datum | 緯度経度の測地系 | 文字列 | wgs84 | wgs84:世界測地系 tokyo:旧日本測地系 |
||
| coord_unit | 出力データに含まれる緯度経度の単位 | 文字列 | degree | degree:度表記の10進法 millisec:ミリ秒表記 |
徒歩の速度指定について
所要時間の精度向上のため、指定された速度を基準にルートの諸条件を考慮したものが利用されます。
必ずしも指定した速度の通りの所要時間にはならないことがありますので、予めご了承ください。
パラメータ構成例
・東京タワーから歩いて3kmで到達出来る12地点を探索
/reachable_walk?start=35.658639,139.745471&range=3000&partition_count=12
レスポンス
| 名称 | レスポンス名 | 型名 | 配列 | Nullable | 説明 |
|---|---|---|---|---|---|
| 検索数 | count | 数値 | 出力された情報数 | ||
| 到達圏結果情報 | items | ReachablePointオブジェクト | 〇 | 到達圏結果情報のまとまり | |
| 単位情報 | unit | Unitオブジェクト | 出力される単位の情報 |
ReachablePointオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | Nullable | 説明 |
|---|---|---|---|---|---|
| 所要時間 | time | 数値 | nullable | その地点へ到達するまでの時間 | |
| 緯度経度 | coord | Coordinateオブジェクト | 地点の緯度経度 |
Coordinateオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | Nullable | 説明 |
|---|---|---|---|---|---|
| 緯度 | lat | 数値 | |||
| 経度 | lon | 数値 |
Unitオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | Nullable | 説明 |
|---|---|---|---|---|---|
| 緯度経度の測地系 | datum | 文字列 | nullable | ||
| 緯度経度の出力形式 | coord_unit | 文字列 | nullable | ||
| 時間の単位 | time | 文字列 | nullable | minute:分 パラメータで'term'を指定した場合のみ出力 |
レスポンス例
{
"count": 12,
"items": [
{
"coord": {
"lat": 35.636794,
"lon": 139.733312
}
},
{
"coord": {
"lat": 35.646803,
"lon": 139.725548
}
},
{
"coord": {
"lat": 35.650247,
"lon": 139.720565
}
},
{
・・・
}
],
"unit": {
"datum": "wgs84",
"coord_unit": "degree"
}
}
エラー情報
エラーハンドリングについて
エラーメッセージは追加/変更/削除されることがあります。
エラーハンドリングされる場合はHTTPステータスコードをもとにご対応ください。
共通エラーについてはこちらをご参照ください。
| HTTPステータス | エラーメッセージ | 発生理由 |
|---|---|---|
| 405 | "This http method is invalid : POST"(等) | 許可されていないHTTPメソッドでアクセスされた場合に発生します。 |
| 400 | parameter error: start: "required field" | 必須パラメータである start が指定されていない、または空文字の場合に発生します。 |
| 400 | parameter error: start: "no definitions validate {'anyof definition 0': ['an invalid code: {value}'], 'anyof definition 1': ['an invalid coordinate : {value}']}" | start に指定した値のフォーマットが不正、または正しくない文字列が含まれている場合に発生します。 |
| 400 | parameter error: term: "required field", range: "required field" |
term, range のいずれも指定されていない場合に発生します。 |
| 400 | parameter error: term: "'range' must not be present with 'term'", range: "'term' must not be present with 'range'" |
term と range を同時に指定した場合に発生します。 |
| 400 | parameter error: term: "field 'term' cannot be coerced: invalid literal for int() with base 10: '{value}'" | term に数値以外の文字列を指定した場合に発生します。 |
| 400 | parameter error: term: "min value is 1" | term に下限値(1未満)の範囲外の値を指定した場合に発生します。 |
| 400 | parameter error: term: "max value is 180" | term に上限値(180超過)の範囲外の値を指定した場合に発生します。 |
| 400 | parameter error: range: "field 'range' cannot be coerced: invalid literal for int() with base 10: '{value}'" | range に数値以外の文字列を指定した場合に発生します。 |
| 400 | parameter error: range: "min value is 1" | range に下限値(1未満)の範囲外の値を指定した場合に発生します。 |
| 400 | parameter error: range: "max value is 10000" | range に上限値(10000超過)の範囲外の値を指定した場合に発生します。 |
| 400 | parameter error: partition_count: "value does not match 到達圏探索の分割数指定値判定" |
partition_count に 3, 4, 6, 9, 12, 18, 36, 40, 45, 60, 72, 90 以外の値を指定した場合に発生します。 |
| 400 | parameter error: walk_speed: "an invalid float: {value}" | walk_speed の小数部を2桁以上指定した場合に発生します(小数第一位までが有効です)。 |
| 400 | parameter error: walk_speed: "min value is 3.0" | walk_speed に数値以外の文字列を指定した場合や、下限値(3.0未満)の範囲外の値を指定した場合に発生します。 |
| 400 | parameter error: walk_speed: "max value is 8.0" | walk_speed に上限値(8.0超過)の範囲外の値を指定した場合に発生します。 |
| 400 | parameter error: datum: "unallowed value {value}" | datum に wgs84, tokyo 以外の不正な値を指定した場合に発生します。 |
| 400 | parameter error: coord_unit: "unallowed value {value}" | coord_unit に degree, millisec 以外の不正な値を指定した場合に発生します。 |