表層地盤情報提供API
バージョン
リクエストURL
目次
リクエスト
– URL
– メッシュコード指定
– 経度緯度指定
– パラメータ
レスポンス
– ステータスコード
– 正常ケース
– GeoJSON形式
– GML形式
– エラーケース
– エラー分類コード
– GeoJSON形式
– GML形式
リクエスト
URL
位置はメッシュコードで指定する方法と経度緯度で指定する方法があります。URL中の太字はリクエストパラメータを示し、上付き番号はパラメータ一覧表のNoに対応します。
メッシュコード指定
経度緯度指定
パラメータ
APIのリクエストパラメータは以下の通りです。パラメータは大文字・小文字を区別して指定して下さい。
| No | パラメータ | 省略可否 | 説明 |
|---|---|---|---|
| 1 | version | 必須 | 表層地盤データのバージョンコード
詳細はバージョンコード一覧を参照して下さい。 |
| 2 | format | 必須 | 出力形式
|
| 3 | meshcode | positionと排他的 | 250mメッシュコード
詳細はこちらを参照して下さい。 注) positionもしくはepsgが指定された場合はエラーとなります。 |
| 4 | position | meshcodeと排他的 | 経度と緯度をコンマ区切りで指定します。 指定可能範囲は以下の通りです。
注1) epsg指定時は必須です。 |
| 5 | epsg | meshcodeと排他的 | EPSGコード
注1) position指定時は必須です。 |
| 6 | attr | 省略可 | 表層地盤属性コード
詳細は表層地盤属性コード一覧を参照して下さい。 注) 指定しない場合は全属性情報を取得します。 |
| 6 | lang | 省略可 | レスポンスの言語
注) 省略時は「ja」となります。 |
バージョンコードの一覧を以下に示します。
| バージョンコード | 概要 |
|---|---|
| V1 | 2005 年~2008 年の「確率論的地震動予測地図」で使用した、3 次メッシュ単位データを 16 分割し 250m メッシュ単位に変換したデータ |
| V2 | 2009 年の「全国地震動予測地図」で使用した、250m メッシュ単位データ |
| V3 | 2014 年の「全国地震動予測地図」で使用した、250m メッシュ単位データ |
| V4 | 2020 年の「全国地震動予測地図」で使用した、250m メッシュ単位データ |
表層地盤属性コードの一覧を以下に示します。
| 属性名 | 出力形式 | 説明 |
|---|---|---|
| JCODE | %2d | 微地形分類コード 基準年により分類区分が異なるので注意して下さい。 詳細はJ-SHISデータ規約集の「表層地盤データ記述ファイル規約」を参照して下さい。 |
| JNAME | %s | 微地形区分名
詳細はJ-SHISデータ規約集の「表層地盤データ記述ファイル規約」を参照して下さい。 |
| AVS | %5.1f | 表層30mの平均S波速度(m/s) |
| ARV | %9.4f | 工学的基盤(Vs=400m/s)から地表に至る最大速度の増幅率 |
| AVS_EB | %5.1f | 詳細法工学的基盤面深さ30mの平均S波速度。値が定義されていないメッシュは「-」となります。 注)バージョン4のみの属性です。 |
AVS_REF | %d | 表層30mの平均S波速度出典番号
注)バージョン4のみの属性です。 |
レスポンス
ステータスコード
データを正常に取得した場合は、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 | 250mメッシュコード
詳細はこちらを参照して下さい。 |
||
| JCODE | 微地形分類コード
詳細は表層地盤属性コード一覧を参照して下さい。 |
||
| JNAME | 微地形区分名
詳細は表層地盤属性コード一覧を参照して下さい。 |
||
| AVS | 表層30mの平均S波速度(m/s)
詳細は表層地盤属性コード一覧を参照して下さい。 |
||
| ARV | 工学的基盤(Vs=400m/s)から地表に至る最大速度の増幅率
詳細は表層地盤属性コード一覧を参照して下さい。 |
||
| AVS_EB | 詳細法工学的基盤面深さ30mの平均S波速度
詳細は表層地盤属性コード一覧を参照して下さい。 |
||
| AVS_REF | 表層30mの平均S波速度出典分類番号
詳細は表層地盤属性コード一覧を参照して下さい。 |
||
| metaData | メタ情報 | ||
| meshcode | 250mメッシュコード
詳細はこちらを参照して下さい。 |
||
| version | バージョンコード | ||
| attr | 表層地盤属性 | ||
| name | 表層地盤属性コード
詳細は表層地盤属性コード一覧を参照して下さい。 |
||
| unit | 表層地盤属性値の単位 |
以下の例はGeoJSON形式レスポンスのサンプルです。
sstrct/V2/meshinfo.geojson?position=139.7486814,35.65531022&epsg=4301
{
"type": "FeatureCollection",
"crs": {
"type": "name",
"properties": {
"name": "urn:ogc:def:crs:EPSG:4301"
}
},
"status": "Success",
"features": [
{
"type": "Feature",
"geometry": {
"coordinates": [
[
[
139.74687,
35.65417
],
[
139.74687,
35.65625
],
[
139.75,
35.65625
],
[
139.75,
35.65417
],
[
139.74687,
35.65417
]
]
],
"type": "Polygon"
},
"properties": {
"meshcode": "5339358942N",
"JCODE": "9",
"JNAME": "ローム台地",
"AVS": "246.9",
"ARV": "1.5083"
}
}
],
"metaData": {
"meshcode": "5339358942N",
"version": "V2",
"attr": [
{
"name": "JNAME",
"unit": ""
},
{
"name": "JCODE",
"unit": ""
},
{
"name": "AVS",
"unit": "m/s"
},
{
"name": "ARV",
"unit": ""
}
]
}
}
GML形式
GML形式のレスポンスは以下の通りです。
| タグ | 説明 | |||
|---|---|---|---|---|
| gml: boundedBy |
レスポンスに含まれる全ジオメトリのバウンディングボックス | |||
| gml: featureMember |
メンバー要素 | |||
| jshis: mesh |
メッシュ | |||
| gml: coverage |
メッシュ矩形のジオメトリ情報 | |||
| jshis: meshcode |
250mメッシュコード
詳細はこちらを参照して下さい。 |
|||
| jshis: JCODE |
微地形分類コード
詳細は表層地盤属性コード一覧を参照して下さい。 |
|||
| jshis: JNAME |
微地形区分名
詳細は表層地盤属性コード一覧を参照して下さい。 |
|||
| jshis: AVS |
表層30mの平均S波速度(m/s)
詳細は表層地盤属性コード一覧を参照して下さい。 |
|||
| jshis: ARV |
工学的基盤(Vs=400m/s)から地表に至る最大速度の増幅率
詳細は表層地盤属性コード一覧を参照して下さい。 |
|||
| jshis: AVS_EB |
詳細法工学的基盤面深さ30mの平均S波速度
詳細は表層地盤属性コード一覧を参照して下さい。 |
|||
| jshis: AVS_REF |
表層30mの平均S波速度出典分類番号
詳細は表層地盤属性コード一覧を参照して下さい。 |
|||
| jshis: status |
ステータス
|
|||
| jshis: metaData |
メタ情報 | |||
| jshis: meshcode |
250mメッシュコード
詳細はこちらを参照して下さい。 |
|||
| jshis: version |
バージョンコード | |||
| jshis: attrs |
表層地盤属性配列 | |||
| jshis: attr |
表層地盤属性 | |||
| jshis: name |
表層地盤属性コード
詳細は表層地盤属性コード一覧を参照して下さい。 |
|||
| jshis: unit |
表層地盤属性値の単位 |
以下の例はGML形式レスポンスのサンプルです。
<?xml version="1.0" encoding="utf-8"?>
<jshis:SstrctMeshinfo 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/sstrct-meshinfo-v1.0.xsd">
<gml:boundedBy>
<gml:Box srsName="urn:ogc:def:crs:EPSG:4301">
<gml:coord>
<gml:X>139.74687</gml:X>
<gml:Y>35.65417</gml:Y>
</gml:coord>
<gml:coord>
<gml:X>139.75</gml:X>
<gml:Y>35.65625</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>139.74687,35.65417 139.74687,35.65625 139.75,35.65625 139.75,35.65417 139.74687,35.65417 </gml:coordinates>
</gml:LinearRing>
</gml:outerBoundaryIs>
</gml:Polygon>
</gml:coverage>
<jshis:meshcode>5339358942N</jshis:meshcode>
<jshis:JCODE>13</jshis:JCODE>
<jshis:JNAME>谷底平野</jshis:JNAME>
<jshis:AVS>205.0</jshis:AVS>
<jshis:ARV>1.5371</jshis:ARV>
</jshis:mesh>
</gml:featureMember>
<jshis:status>Success</jshis:status>
<jshis:metaData>
<jshis:meshcode>5339358942N</jshis:meshcode>
<jshis:version>V1</jshis:version>
<jshis:attrs>
<jshis:attr>
<jshis:name>JNAME</jshis:name>
<jshis:unit/>
</jshis:attr>
<jshis:attr>
<jshis:name>JCODE</jshis:name>
<jshis:unit/>
</jshis:attr>
<jshis:attr>
<jshis:name>AVS</jshis:name>
<jshis:unit>m/s</jshis:unit>
</jshis:attr>
<jshis:attr>
<jshis:name>ARV</jshis:name>
<jshis:unit/>
</jshis:attr>
</jshis:attrs>
</jshis:metaData>
</jshis:SstrctMeshinfo>
エラーケース
エラー分類コード
エラー分類コードは以下の通りです。
| 分類コード | 説明 |
|---|---|
| INVALID_REQUEST | 指定したリクエストに誤りがある。 |
| DB_CONNECT_ERROR | DBに関するエラーが発生した。 |
| UNKNOWN_ERROR | 未定義のエラーが発生した。 |
| NOT_FOUND | 該当するデータが存在しない。 |
GeoJSON形式
GeoJSON形式のリクエストでエラーが発生した場合のレスポンスは以下の通りです。
| タグ | 説明 | |
|---|---|---|
| type | GeoJSONオブジェクトタイプ
|
|
| status | ステータス
|
|
| error | エラー情報 | |
| code | エラー分類コード | |
| message | エラー内容を示すメッセージ | |
| features | 空の配列 |
以下の例はGeoJSON形式エラーレスポンスのサンプルです。
{
"type": "FeatureCollection",
"status": "Error",
"error": {
"code": "NOT_FOUND",
"message": "No data is found for the query"
},
"features": [
{
"geometry": {
"coordinates": [
[]
]
}
}
]
}
GML形式
GML形式のリクエストでエラーが発生した場合のレスポンスは以下の通りです。
| タグ | 説明 | |
|---|---|---|
| gml:boundedBy | null要素
<gml:null>unknown</gml:null> (固定値) |
|
| gml:featureMember | 空の配列 | |
| jshis:status | ステータス
|
|
| jshis:error | エラー情報 | |
| jshis:code | エラー分類コード | |
| jshis:message | エラー内容を示すメッセージ |
以下の例はGML形式エラーレスポンスのサンプルです。
<?xml version="1.0" encoding="utf-8"?>
<jshis:SstrctMeshinfo 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/sstrct-meshinfo-v1.0.xsd">
<gml:boundedBy>
<gml:null>unknown</gml:null>
</gml:boundedBy>
<gml:featureMember/>
<jshis:status>Error</jshis:status>
<jshis:error>
<jshis:code>NOT_FOUND</jshis:code>
<jshis:message>No data is found for the query</jshis:message>
</jshis:error>
</jshis:SstrctMeshinfo>
