その他
地すべり地形情報提供API
指定した250mメッシュが、地すべり地形と交差するかどうかをJSON形式で提供します。
バージョン
1.0.0
リクエストURL
https://www.j-shis.bosai.go.jp/map/api/landslide/isContaining.json?meshcode=meshcode&options
https://www.j-shis.bosai.go.jp/map/api/meshcode/landslide/isContaining.json?options
https://www.j-shis.bosai.go.jp/map/api/landslide/isContaining.json?position=position&epsg=epsg&options
目次
リクエスト
– URL
– メッシュコード指定
– 経度緯度指定
– パラメータ
レスポンス
– ステータスコード
– 正常ケース
– エラーケース
– エラー分類コード
リクエスト
URL
位置はメッシュコードで指定する方法と経度緯度で指定する方法があります。URL中の太字はリクエストパラメータを示し、上付き番号はパラメータ一覧表のNoに対応します。
メッシュコード指定
https://www.j-shis.bosai.go.jp/map/api/landslide/isContaining.json?meshcode=meshcode1&options4
https://www.j-shis.bosai.go.jp/map/api/meshcode1/landslide/isContaining.json?options4
経度緯度指定
https://www.j-shis.bosai.go.jp/map/api/landslide/isContaining.json?position=position2&epsg=epsg3&options4
パラメータ
APIのリクエストパラメータは以下の通りです。パラメータは大文字・小文字を区別して指定して下さい。
| No | パラメータ | 省略可否 | 説明 |
|---|---|---|---|
| 1 | meshcode | positionと排他的 | 日本測地系250mメッシュコード（10桁）+「N」の11桁
詳細はこちらを参照して下さい。 注) positionもしくはepsgが指定された場合はエラーとなります。 |
| 2 | position | meshcodeと排他的 | 経度と緯度をコンマ区切りで指定します。指定可能範囲は以下の通りです。
注1) epsg指定時は必須です。 |
| 3 | epsg | meshcodeと排他的 | EPSGコード
注1) position指定時は必須です。 |
| 4 | lang | 省略可 | レスポンスの言語
省略した場合…ja |
レスポンス
ステータスコード
データを正常に取得した場合は、HTTPステータスコードに200を設定し、正常ケースのレスポンスを返します。エラーが発生した場合は、以下のHTTPステータスコードを設定し、エラーケースのレスポンスを返します。
| HTTPステータスコード | 説明 | |
|---|---|---|
| 400 | Bad Request | リクエストURLに間違いがあることを示します。
例：サポートされていない値を設定した。 |
| 403 | Forbidden | リクエストが拒否されたことを示します。
例：リクエストの上限を超えた。 |
| 404 | Not Found | リクエストに一致するデータが1件も存在しないことを示します。
例：存在しないメッシュコードを指定した。 |
| 500 | Internal Server Error | 内部エラーが発生したことを示します。 |
| 503 | Service Unavailable | サービスが一時的に利用不可であることを示します。
例：DBへの接続に失敗した。 |
正常ケース
正常ケースのレスポンスは以下の通りです。
| タグ | 説明 | ||
|---|---|---|---|
| status | ステータス
|
||
| isContaining | 交差するかどうか
|
||
| metaData | メタ情報 | ||
| meshcode | 日本測地系250mメッシュコード（10桁）+「N」の11桁
詳細はこちらを参照して下さい。 |
||
| url | 選択された250mメッシュを中心としたJ-SHIS MapへのリンクURL | ||
| scarps | 輪郭構造（滑落崖と側方崖）の属性値を含む配列
属性2の詳細は輪郭構造（滑落崖と側方崖）の属性2コード一覧を参照してください。 |
||
| attr1code | 属性1コード
|
||
| attr1name | 属性1凡例名称
|
||
| attr2code | 属性2コード | ||
| attr2name | 属性2凡例名称 | ||
| movingmass_polygons | 輪郭構造（移動体の輪郭・境界）（移動体ポリゴン）の属性値を含む配列
属性2の詳細は輪郭構造（移動体の輪郭・境界）（移動体ポリゴン）の属性2コード一覧を参照してください。 |
||
| attr1code | 属性1コード
|
||
| attr1name | 属性1凡例名称
|
||
| attr2code | 属性2コード | ||
| attr2name | 属性2凡例名称 |
属性1コードが100の場合と300の場合で、属性2コードおよび凡例が異なります。
| 属性1コード | 属性1凡例名称 | ジオメトリ | 属性2 |
|---|---|---|---|
| 100 | 輪郭構造（滑落崖と側方崖） | ライン | 属性2コード参照 |
| 300 | 輪郭構造（移動体の輪郭・境界）（移動体ポリゴン） | ポリゴン | 属性2コード参照 |
輪郭構造（滑落崖と側方崖）の属性2コードの一覧を以下に示します。
| 属性2コード | 属性2凡例名称 |
|---|---|
| 100 | 新鮮なまたは開析されていない冠頂をもつ滑落崖 |
| 200 | 部分的に開析されている冠頂をもつ滑落崖 |
| 300 | 冠頂が著しく開析された滑落崖 |
| 400 | 冠頂が丸みをおびて不明瞭になった滑落崖 |
| 500 | 開析されて無くなってしまった冠頂・滑落崖の推定復元位置 |
| 600 | 滑落崖にあたる急崖を呈しない斜面 |
| 700 | 後方崖、多重稜線等 |
輪郭構造（移動体の輪郭・境界）（移動体ポリゴン）の属性2コードの一覧を以下に示します。
| 属性2コード | 属性2凡例名称 |
|---|---|
| 100 | 斜面移動体 |
| 200 | 不安定域・移動域と推定される範囲 |
| 300 | 斜面移動体かどうか判定できない山体・小丘 |
レスポンスサンプル
リクエストURL
https://www.j-shis.bosai.go.jp/map/api/5940768244N/landslide/isContaining.json
正常レスポンス
{
"status" : "Success",
"isContaining" : 1,
"metaData" : {
"meshcode" : "5940768244N",
"url" : "https://www.j-shis.bosai.go.jp/map/?epoch=Y2013&lang=jp&zoom=12&ls=1¢er=140.78594,39.99063&layer=P-Y2013-MAP-AVR-TTL_MTTL-T30_I55_PD&transparent=1&flt=0,0,0,0",
"scarps" : [
{
"attr1code" : 100,
"attr1name" : "輪郭構造（滑落崖と側方崖）",
"attr2code" : 100,
"attr2name" : "新鮮なまたは開析されていない冠頂をもつ滑落崖"
}, {
"attr1code" : 100,
"attr1name" : "輪郭構造（滑落崖と側方崖）",
"attr2code" : 100,
"attr2name" : "新鮮なまたは開析されていない冠頂をもつ滑落崖"
}, {
"attr1code" : 100,
"attr1name" : "輪郭構造（滑落崖と側方崖）",
"attr2code" : 300,
"attr2name" : "冠頂が著しく開析された滑落崖"
}, {
"attr1code" : 100,
"attr1name" : "輪郭構造（滑落崖と側方崖）",
"attr2code" : 300,
"attr2name" : "冠頂が著しく開析された滑落崖"
}
],
"movingmass_polygons" : [
{
"attr1code" : 300,
"attr1name" : "輪郭構造（移動体の輪郭・境界）（移動体ポリゴン）",
"attr2code" : 300,
"attr2name" : "斜面移動体かどうか判定できない山体・小丘"
}, {
"attr1code" : 300,
"attr1name" : "輪郭構造（移動体の輪郭・境界）（移動体ポリゴン）",
"attr2code" : 100,
"attr2name" : "斜面移動体"
}
]
}
}
エラーケース
エラー分類コード
エラー分類コードは以下の通りです。
| 分類コード | 説明 |
|---|---|
| INVALID_REQUEST | 指定したリクエストに誤りがある。 |
| DB_CONNECT_ERROR | DBに関するエラーが発生した。 |
| UNKNOWN_ERROR | 未定義のエラーが発生した。 |
| NOT_FOUND | 該当するデータが存在しない。 |
エラーが発生した場合のレスポンスは以下の通りです。
| タグ | 説明 | |
|---|---|---|
| status | ステータス
|
|
| error | エラー情報 | |
| code | エラー分類コード | |
| message | エラー内容を示すメッセージ |
レスポンスサンプル
リクエストURL
https://www.j-shis.bosai.go.jp/map/api/5940768244N/landslide/isContaining.json?lang=
エラーレスポンス
{
"status": "Error",
"error": {
"code": "INVALID_REQUEST",
"message": "Supported value for option [ lang ] is ja,en"
}
}
