その他
深部地下構造情報提供API
指定した3次メッシュの深部地下構造モデル各層下面深さ、もしくは下面標高を提供します。
バージョン
1.0.0
リクエストURL
https://www.j-shis.bosai.go.jp/map/api/dstrct/version/attr/meshinfo.format?meshcode=meshcode
https://www.j-shis.bosai.go.jp/map/api/meshcode/dstrct/version/attr/meshinfo.format
https://www.j-shis.bosai.go.jp/map/api/dstrct/version/attr/meshinfo.format?position=position&epsg=epsg
目次
リクエスト
– URL
– メッシュコード指定
– 経度緯度指定
– パラメータ
レスポンス
– ステータスコード
– 正常ケース
– GeoJSON形式
– GML形式
– エラーケース
– エラー分類コード
– GeoJSON形式
– GML形式
リクエスト
URL
位置はメッシュコードで指定する方法と経度緯度で指定する方法があります。URL中の太字はリクエストパラメータを示し、上付き番号はパラメータ一覧表のNoに対応します。
メッシュコード指定
https://www.j-shis.bosai.go.jp/map/api/dstrct/version1/attr2/meshinfo.format3?meshcode=meshcode4
https://www.j-shis.bosai.go.jp/map/api/meshcode4/dstrct/version1/attr2/meshinfo.format3
経度緯度指定
https://www.j-shis.bosai.go.jp/map/api/dstrct/version1/attr2/meshinfo.format3?position=position5&epsg=epsg6
パラメータ
APIのリクエストパラメータは以下の通りです。パラメータは大文字・小文字を区別して指定して下さい。
| No | パラメータ | 省略可否 | 説明 |
|---|---|---|---|
| 1 | version | 必須 | バージョンコード
詳細はバージョンコード一覧を参照して下さい。 |
| 2 | attr | 必須 | 属性種別
|
| 3 | format | 必須 | 出力形式
|
| 4 | meshcode | positionと排他的 | メッシュコード
詳細は3次メッシュコード定義を参照して下さい。 注) positionもしくはepsgが指定された場合はエラーとなります。 |
| 5 | position | meshcodeと排他的 | 経度と緯度をコンマ区切りで指定します。指定可能範囲は以下の通りです。
注1) epsg指定時は必須です。 |
| 6 | epsg | meshcodeと排他的 | EPSGコード
注1) position指定時は必須です。 |
バージョンコードの一覧を以下に示します。
| バージョンコード | 概要 |
|---|---|
| V1 | 藤原広行・河合伸一・青井真・森川信之・先名重樹・工藤暢章・大井昌弘・はお憲生・早川讓・遠山信彦・松山尚典・岩本鋼司・鈴木晴彦・劉瑛（2009）: 強震動評価のための全国深部地盤構造モデル作成手法の検討, 防災科学技術研究所研究資料 第337号 のデータ（注1） |
| V2 | 藤原広行・河合伸一・青井真・森川信之・先名重樹・東宏樹・大井昌弘・はお憲生・長谷川信介・前田宜浩・岩城麻子・若松加寿江・井元政二郎・奥村俊彦・松山尚典・成田章 (2012) : 東日本大震災を踏まえた地震ハザード評価の改良に向けた検討, 防災科学技術研究所研究資料 第379号 のデータ（注1） |
| V3.2 | 地震調査研究推進本部（2021）: 関東地方の浅部・深部統合地盤構造モデル（2021 年版）のデータ |
注1) 関連文献リストからダウンロードすることができます。
レスポンス
ステータスコード
データを正常に取得した場合は、HTTPステータスコードに200を設定し、正常ケースのレスポンスを返します。エラーが発生した場合は、以下のHTTPステータスコードを設定し、エラーケースのレスポンスを返します。
| HTTPステータスコード | 説明 | |
|---|---|---|
| 400 | Bad Request | リクエストURLに間違いがあることを示します。
例：サポートされていない値を設定した。 |
| 403 | Forbidden | リクエストが拒否されたことを示します。
例：リクエストの上限を超えた。 |
| 404 | Not Found | リクエストに一致するデータが1件も存在しないことを示します。
例：存在しないメッシュコードを指定した。 |
| 500 | Internal Server Error | 内部エラーが発生したことを示します。 |
| 503 | Service Unavailable | サービスが一時的に利用不可であることを示します。
例：DBへの接続に失敗した。 |
正常ケース
GeoJSON形式
GeoJSON形式のレスポンスは以下の通りです。
| タグ | 説明 | ||
|---|---|---|---|
| type | GeoJSONオブジェクトタイプ
|
||
| crs | GeoJSON 座標参照系オブジェクト 座標参照系情報 |
||
| status | ステータス
|
||
| features | メンバー要素 メッシュ矩形ジオメトリとその属性値の配列 |
||
| type | GeoJSONオブジェクトタイプ
|
||
| geometry | メッシュ矩形のジオメトリ情報 | ||
| properties | ジオメトリの属性値を含むオブジェクト | ||
| meshcode | メッシュコード
詳細は3次メッシュコード定義を参照して下さい。 |
||
| sn0 | 深さの場合…0（固定値） 標高の場合…地表標高 注) V3.2のみの属性です。 |
||
| tn0 |
バージョン1、バージョン2：
バージョン3.2：
|
||
| tn1 | 1層目の下端深さ（標高） | ||
| tn2 | 2層目の下端深さ（標高） | ||
| ・・ | ・・・ | ||
| tnN | N層目の下端深さ（標高） | ||
| metaData | メタ情報 | ||
| meshcode | メッシュコード
詳細は3次メッシュコード定義を参照して下さい。 |
||
| version | バージョンコード | ||
| attr | 属性 | ||
| name | 属性種別
|
||
| unit | 単位 |
以下の例はGeoJSON形式レスポンスのサンプルです。
レスポンスサンプル
リクエストURL
https://www.j-shis.bosai.go.jp/map/api/dstrct/V1/LYRD/meshinfo.geojson?meshcode=54401047N
GeoJSON形式レスポンス
{
"type": "FeatureCollection",
"crs": {
"type": "name",
"properties": {
"name": "urn:ogc:def:crs:EPSG:4301"
}
},
"status": "Success",
"features": [
{
"type": "Feature",
"geometry": {
"coordinates": [
[
[
140.0875,
36.116667
],
[
140.0875,
36.11875
],
[
140.090625,
36.11875
],
[
140.090625,
36.116667
],
[
140.0875,
36.116667
]
]
],
"type":"Polygon"
},
"properties": {
"meshcode":"54401047N",
"tn0" :"0" , "tn1" :"0" , "tn2" :"0" , "tn3" :"0" , "tn4" :"264",
"tn5" :"264", "tn6" :"264", "tn7" :"264", "tn8" :"264", "tn9" :"264",
"tn10":"264", "tn11":"264", "tn12":"400", "tn13":"400", "tn14":"400",
"tn15":"400", "tn16":"400", "tn17":"400", "tn18":"400", "tn19":"535",
"tn20":"535", "tn21":"535", "tn22":"535", "tn23":"535", "tn24":"535",
"tn25":"535", "tn26":"535", "tn27":"670", "tn28":"670", "tn29":"670",
"tn30":"670", "tn31":"2158","tn32":"7158"
}
}
],
"metaData": {
"meshcode": "54401047N",
"version": "V1",
"attr": [
{
"name": "LYRD",
"unit": "m"
}
]
}
}
GML形式
GML形式のレスポンスは以下の通りです。
| タグ | 説明 | |||
|---|---|---|---|---|
| gml: boundedBy |
レスポンスに含まれる全ジオメトリのバウンディングボックス | |||
| gml: featureMember |
メンバー要素 | |||
| jshis: mesh |
メッシュ | |||
| gml: coverage |
メッシュ矩形のジオメトリ情報 | |||
| jshis: meshcode |
メッシュコード
詳細は3次メッシュコード定義を参照して下さい。 |
|||
| jshis: sn0 |
深さの場合…0（固定値） 標高の場合…地表標高 注) バージョン3.2のみの属性です。 |
|||
| jshis: tn0 |
バージョン1、バージョン2:
バージョン3.2:
|
|||
| jshis: tn1 |
1層目の下端深さ（標高） | |||
| jshis: tn2 |
2層目の下端深さ（標高） | |||
| ・・・ | ・・・ | |||
| jshis: tnN |
N層目の下端深さ（標高） | jshis: status |
ステータス
|
|
| jshis: metaData |
メタ情報 | |||
| jshis: meshcode |
メッシュコード
詳細は3次メッシュコード定義を参照して下さい。 |
|||
| jshis: version |
バージョンコード | |||
| jshis: attrs |
属性の配列 | |||
| jshis: attr |
属性 | |||
| jshis: name |
属性種別
|
|||
| jshis: unit |
単位 |
以下の例はGML形式レスポンスのサンプルです。
レスポンスサンプル
リクエストURL
https://www.j-shis.bosai.go.jp/map/api/dstrct/V1/LYRD/meshinfo.gml?meshcode=54401047N
GML形式レスポンス
<?xml version="1.0" encoding="utf-8" ?>
<jshis:DstrctMeshinfo
xmlns:jshis="http://www.j-shis.bosai.go.jp"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.j-shis.bosai.go.jp dstrct-meshinfo-v1.0.xsd"
xmlns:gml="http://www.opengis.net/gml">
<gml:boundedBy>
<gml:Box srsName="urn:ogc:def:crs:EPSG:4301">
<gml:coord><gml:X>140.0890625</gml:X><gml:Y>36.117708</gml:Y></gml:coord>
<gml:coord><gml:X>140.0953125</gml:X><gml:Y>36.121875</gml:Y></gml:coord>
</gml:Box>
</gml:boundedBy>
<gml:featureMember>
<jshis:mesh>
<gml:coverage>
<gml:Polygon srsName="urn:ogc:def:crs:EPSG:4301">
<gml:outerBoundaryIs>
<gml:LinearRing>
<gml:coordinates>
140.0875,36.116667
140.0875,36.11875
140.090625,36.11875
140.090625,36.116667
140.0875,36.116667
</gml:coordinates>
</gml:LinearRing>
</gml:outerBoundaryIs>
</gml:Polygon>
</gml:coverage>
<jshis:meshcode>54401047N</jshis:meshcode>
<jshis:tn0>0</jshis:tn0><jshis:tn1>0</jshis:tn1><jshis:tn2>0</jshis:tn2>
<jshis:tn3>0</jshis:tn3><jshis:tn4>264</jshis:tn4><jshis:tn5>264</jshis:tn5>
<jshis:tn6>264</jshis:tn6><jshis:tn7>264</jshis:tn7><jshis:tn8>264</jshis:tn8>
<jshis:tn9>264</jshis:tn9><jshis:tn10>264</jshis:tn10>
<jshis:tn11>264</jshis:tn11><jshis:tn12>400</jshis:tn12>
<jshis:tn13>400</jshis:tn13><jshis:tn14>400</jshis:tn14>
<jshis:tn15>400</jshis:tn15><jshis:tn16>400</jshis:tn16>
<jshis:tn17>400</jshis:tn17><jshis:tn18>400</jshis:tn18>
<jshis:tn19>535</jshis:tn19><jshis:tn20>535</jshis:tn20>
<jshis:tn21>535</jshis:tn21><jshis:tn22>535</jshis:tn22>
<jshis:tn23>535</jshis:tn23><jshis:tn24>535</jshis:tn24>
<jshis:tn25>535</jshis:tn25><jshis:tn26>670</jshis:tn26>
<jshis:tn27>670</jshis:tn27><jshis:tn28>670</jshis:tn28>
<jshis:tn29>670</jshis:tn29><jshis:tn30>670</jshis:tn30>
<jshis:tn31>2158</jshis:tn31><jshis:tn32>7158</jshis:tn32>
</jshis:mesh>
</gml:featureMember>
<jshis:status>Success</jshis:status>
<jshis:metaData>
<jshis:meshcode>54401047N</jshis:meshcode>
<jshis:version>V1</jshis:version>
<jshis:attrs>
<jshis:attr>
<jshis:name>LYRD</jshis:name>
<jshis:unit>m</jshis:unit>
</jshis:attr>
</jshis:attrs>
</jshis:metaData>
</jshis:DstrctMeshinfo>
エラーケース
エラー分類コード
エラー分類コードは以下の通りです。
| 分類コード | 説明 |
|---|---|
| INVALID_REQUEST | 指定したリクエストに誤りがある。 |
| DB_CONNECT_ERROR | DBに関するエラーが発生した。 |
| UNKNOWN_ERROR | 未定義のエラーが発生した。 |
| NOT_FOUND | 該当するデータが存在しない。 |
GeoJSON形式
GeoJSON形式のリクエストでエラーが発生した場合のレスポンスは以下の通りです。
| タグ | 説明 | |
|---|---|---|
| type | GeoJSONオブジェクトタイプ
|
|
| status | ステータス
|
|
| error | エラー情報 | |
| code | エラー分類コード | |
| message | エラー内容を示すメッセージ | |
| features | 空の配列 |
以下の例はGeoJSON形式エラーレスポンスのサンプルです。
レスポンスサンプル
リクエストURL
https://www.j-shis.bosai.go.jp/map/api/53393589N/dstrct/V1/lyre/meshinfo.json
GeoJSON形式エラーレスポンス
{
"type": "FeatureCollection",
"status": "Error",
"error": {
"code": "INVALID_REQUEST",
"message": "Supported formats are geojson, gml"
},
"features": [
{
"geometry": {
"coordinates": [
[]
]
}
}
]
}
GML形式
GML形式のリクエストでエラーが発生した場合のレスポンスは以下の通りです。
| タグ | 説明 | |
|---|---|---|
| gml:boundedBy | null要素
<gml:null>unknown</gml:null> （固定値） |
|
| gml:featureMember | 空の配列 | |
| jshis:status | ステータス
|
|
| jshis:error | エラー情報 | |
| jshis:code | エラー分類コード | |
| jshis:message | エラー内容を示すメッセージ |
以下の例はGML形式エラーレスポンスのサンプルです。
レスポンスサンプル
リクエストURL
https://www.j-shis.bosai.go.jp/map/api/53393589N/dstrct/V1/lyre/meshinfo.gml
GML形式エラーレスポンス
<?xml version="1.0" encoding="utf-8"?>
<jshis:DstrctMeshinfo xmlns:gml="http://www.opengis.net/gml"
xmlns:jshis="http://www.j-shis.bosai.go.jp" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.j-shis.bosai.go.jp
http:// www.j-shis.bosai.go.jp/map/xsd/gml-v2.1.2/dstrct-meshinfo-v1.0.xsd">
<gml:boundedBy>
<gml:null>unknown</gml:null>
</gml:boundedBy>
<gml:featureMember/>
<jshis:status>Error</jshis:status>
<jshis:error>
<jshis:code>INVALID_REQUEST</jshis:code>
<jshis:message>Supported options for [attr] are : LYRD / LYRE </jshis:message>
</jshis:error>
</jshis:DstrctMeshinfo>
