長期間平均ハザード情報提供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 | 省略可 | 地震ハザード属性
詳細は地震ハザード属性一覧を参照して下さい。指定しない場合は全属性情報を取得します。 |
バージョンコードの一覧を以下に示します。
バージョンコード | 概要 |
---|---|
V1 | 2012年版の確率論的地震動予測地図で使用した地震活動モデルを基準にポアソン過程で評価 |
V2 | 2013年版モデル2の確率論的地震動予測地図で使用した地震活動モデルを基準にポアソン過程で評価 |
V3 | 2013年版モデル1の確率論的地震動予測地図で使用した地震活動モデルを基準にポアソン過程で評価 |
V4 | 2014年版の確率論的地震動予測地図で使用した地震活動モデルを基準にポアソン過程で評価 |
V5 | 2016年版の確率論的地震動予測地図で使用した地震活動モデルを基準にポアソン過程で評価 |
V6 | 2017年版の確率論的地震動予測地図で使用した地震活動モデルを基準にポアソン過程で評価 |
V7 | 2018年版の確率論的地震動予測地図で使用した地震活動モデルを基準にポアソン過程で評価 |
V8 | 2020年版の確率論的地震動予測地図で使用した地震活動モデルを基準にポアソン過程で評価 |
地震ハザード属性の一覧を以下に示します。
属性名 | 出力形式 | 説明 |
---|---|---|
A0500_SI | %s | 再現期間 500年相当の震度 |
A1000_SI | %s | 再現期間 1000年相当の震度 |
A5000_SI | %s | 再現期間 5000年相当の震度 |
A010K_SI | %s | 再現期間 1万年相当の震度 |
A050K_SI | %s | 再現期間 5万年相当の震度 |
A100K_SI | %s | 再現期間 10万年相当の震度 |
レスポンス
ステータスコード
データを正常に取得した場合は、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メッシュコード
詳細はこちらを参照して下さい。 |
||
地震ハザード属性名称(A0500_SIなど) | 地震ハザード属性
詳細は地震ハザード属性一覧を参照して下さい。 |
||
metaData | メタ情報 | ||
meshcode | 250mメッシュコード
詳細はこちらを参照して下さい。 |
||
version | 地図バージョン | ||
attr | 地震ハザード属性名配列 | ||
name | 地震ハザード属性
詳細は地震ハザード属性一覧を参照して下さい。 |
||
unit | 属性値の単位 |
以下の例はGeoJSON形式レスポンスのサンプルです。
{ "type": "FeatureCollection", "crs": { "type": "name", "properties": { "name": "urn:ogc:def:crs:EPSG:4301" } }, "status": "Success", "features": [ { "type": "Feature", "geometry": { "coordinates": [ [ [ 140.08437, 36.07292 ], [ 140.08437, 36.075 ], [ 140.0875, 36.075 ], [ 140.0875, 36.07292 ], [ 140.08437, 36.07292 ] ] ], "type": "Polygon" }, "properties": { "meshcode": "5440008644N" "A0500_SI": "6L", } } ], "metaData": { "meshcode": "5440008644N", "version": "V1", "attr": [ { "name": "A0500_SI", "unit": "" } ] } }
GML形式
GML形式のレスポンスは以下の通りです。
タグ | 説明 | |||
---|---|---|---|---|
gml: boundedBy |
レスポンスに含まれる全ジオメトリのバウンディングボックス | |||
gml: featureMember |
メンバー要素 | |||
jshis: mesh |
メッシュ | |||
gml: coverage |
メッシュ矩形のジオメトリ情報 | |||
jshis: meshcode |
250mメッシュコード
詳細はこちらを参照して下さい。 |
|||
地震ハザード属性名称 (A0500_SIなど) |
地震ハザード属性
詳細は地震ハザード属性一覧を参照して下さい。 |
|||
jshis: status |
ステータス
|
|||
jshis: metaData |
メタ情報 | |||
jshis: version |
地図バージョン | |||
jshis: meshcode |
250mメッシュコード
詳細はこちらを参照して下さい。 |
|||
jshis: attrs |
地震ハザード属性配列 | |||
jshis: attr |
レスポンスに含まれる地震ハザード属性 | |||
jshis: name |
地震ハザード属性
詳細は地震ハザード属性一覧を参照して下さい。 |
|||
jshis: unit |
地震ハザード属性の単位 |
以下の例はGML形式レスポンスのサンプルです。
<?xml version="1.0" encoding="utf-8"?> <jshis:AvghzdMeshinfo 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/avghzd-meshinfo-v1.0.xsd"> <gml:boundedBy> <gml:Box srsName="urn:ogc:def:crs:EPSG:4301"> <gml:coord> <gml:X>140.08437</gml:X> <gml:Y>36.07292</gml:Y> </gml:coord> <gml:coord> <gml:X>140.0875</gml:X> <gml:Y>36.075</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.08437,36.07292 140.08437,36.075 140.0875,36.075 140.0875,36.07292 140.08437,36.07292 </gml:coordinates> </gml:LinearRing> </gml:outerBoundaryIs> </gml:Polygon> </gml:coverage> <jshis:meshcode>5440008644N</jshis:meshcode> <jshis:A0500_SI>6L</jshis:A0500_SI> </jshis:mesh> </gml:featureMember> <jshis:status>Success</jshis:status> <jshis:metaData> <jshis:version>V1</jshis:version> <jshis:meshcode>5440008644N</jshis:meshcode> <jshis:attrs> <jshis:attr> <jshis:name>A0500_SI</jshis:name> <jshis:unit/> </jshis:attr> </jshis:attrs> </jshis:metaData> </jshis:AvghzdMeshinfo>
エラーケース
エラー分類コード
エラー分類コードは以下の通りです。
分類コード | 説明 |
---|---|
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": "INVALID_REQUEST", "message": "Supported value for option [ version ] is V1,V2,V3,V4,V5,V6,V7,V8" }, "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:AvghzdMeshinfo 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/avghzd-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 value for option [ version ] is V1,V2,V3,V4,V5,V6,V7,V8</jshis:message> </jshis:error> </jshis:AvghzdMeshinfo>