自治体別被害地震検索API
バージョン
リクエストURL
目次
リクエスト
– URL
– パラメータ
レスポンス
– ステータスコード
– 正常ケース
– JSON形式
– XML形式
– エラーケース
– エラー分類コード
– JSON形式
– XML形式
リクエスト
URL
URL中の太字はリクエストパラメータを示し、上付き番号はパラメータ一覧表のNoに対応します。
パラメータ
APIのリクエストパラメータは以下の通りです。パラメータは大文字・小文字を区別して指定して下さい。
| No | パラメータ | 省略可否 | 説明 |
|---|---|---|---|
| 1 | areacode | 必須 | 総務省地方公共団体コード(5桁)+「A」の6桁
|
| 2 | ecode | 必須 | 人口コード
|
| 3 | mode | 必須 | 想定地震コード
|
| 4 | version | 必須 | 地図バージョン
|
| 5 | case | 必須 | 確率ケース
|
| 6 | period | 必須 | 発生確率評価期間
|
| 7 | format | 必須 | 出力形式
|
| 8 | param | 省略可 | 評価パラメータ(カタストロフ重視度)を指定します。指定可能な範囲は以下の通りです。
省略した場合…0.6 注1) Y年間震度I以上の揺れに曝されるときの一般化リスク指標RG(α;Y,I)を以下のように定義します(能島・他、2010)。
注2) カタストロフ重視度の具体例を以下に示します。
|
| 8 | ijma | 省略可 | 超過確率しきい震度
省略した場合…45 |
| 8 | lang | 省略可 | レスポンスの言語
省略した場合…ja |
レスポンス
ステータスコード
データを正常に取得した場合は、HTTPステータスコードに200を設定し、正常ケースのレスポンスを返します。エラーが発生した場合は、以下のHTTPステータスコードを設定し、エラーケースのレスポンスを返します。
| HTTPステータスコード | 説明 | |
|---|---|---|
| 400 | Bad Request | リクエストURLに間違いがあることを示します。
例:サポートされていない値を設定した。 |
| 403 | Forbidden | リクエストが拒否されたことを示します。
例:リクエストの上限を超えた。 |
| 404 | Not Found | リクエストに一致するデータが1件も存在しないことを示します。
例:存在しないメッシュコードを指定した。 |
| 500 | Internal Server Error | 内部エラーが発生したことを示します。 |
| 503 | Service Unavailable | サービスが一時的に利用不可であることを示します。
例:DBへの接続に失敗した。 |
正常ケース
JSON形式
JSON形式のレスポンスは以下の通りです。
| タグ | 説明 | |
|---|---|---|
| status | ステータス
|
|
| Fault | 断層リストメンバー要素
|
|
| rank | 順位 scoreの大きい順に1から増加します。 |
|
| ltecode | 断層コード
詳細は断層コード規約を参照してください。 |
|
| ltecase | 断層ケース名 | |
| ltename | 断層名称 | |
| eqcode | 地震コード
詳細は地震コード規約を参照してください。 |
|
| eqgroup | 地震グループ
|
|
| eqcategory | <2008~2019年版> 地震カテゴリー
<2020年版~>
|
|
| case | 平均/最大ケース
|
|
| probability | 発生確率 | |
| magnitude | マグニチュード 正の場合は気象庁マグニチュードを示し、負の場合はモーメントマグニチュードを示します。 マグニチュードに範囲がある場合は、最小値と最大値をコンマ区切りで記載します。 例:マグニチュード6.0から6.5の場合…「6.0,6.5」 |
|
| score | 評価関数値 絶対値に意味はありませんが、影響が大きいほど大きな値となります。 |
|
| pex | 震度曝露人口 発生パターンが考慮されている地震の場合は、発生パターンリストメンバの値と、各地震の発生パターンに付与されている重みの値から算出した重み付き平均値です。 |
|
| Pattern | 発生パターンリストメンバー要素 発生パターンが考慮されている地震のみ存在します。 各要素の詳細は発生パターン属性表を参照してください。 |
|
| metaData | メタ情報メンバー要素
|
|
| areacode | 総務省地方公共団体コード(5桁)+「A」の6桁
|
|
| ecode | 人口コード | |
| mode | 想定地震コード | |
| version | 地図バージョン | |
| case | 確率ケース | |
| period | 発生確率評価期間 | |
| param | 評価パラメータ | |
| ijma | 超過確率しきい震度 | |
| lang | 言語 |
以下の例はJSON形式レスポンスのサンプルです。
{
"Fault": [
{
"case": "MAX",
"eqcategory": "3",
"eqcode": "LND_A98F",
"eqgroup": "A",
"ltecase": "1",
"ltecode": "F01482B",
"ltename": "深谷断層・綾瀬川断層(鴻巣-伊奈区間と伊奈-川口区間が同時に活動)",
"magnitude": "-7",
"pex": "8145",
"probability": "0.00000000",
"rank": "3",
"score": "0.000e+00"
},
{
"case": "MAX",
"eqcategory": "3",
"eqcode": "LND_A98F",
"eqgroup": "A",
"ltecase": "1",
"ltecode": "F01482C",
"ltename": "深谷断層・綾瀬川断層(全体が同時に活動)",
"magnitude": "-7.5",
"pex": "59805",
"probability": "0.00000000",
"rank": "2",
"score": "0.000e+00"
},
{
"case": "MAX",
"eqcategory": "4",
"eqcode": "PLE_ASGMI",
"eqgroup": "C",
"ltecase": "1",
"ltecode": "ASGMI",
"ltename": "相模トラフ沿いのM8クラスの地震",
"magnitude": "-7.9,-8.6",
"pex": "13193",
"probability": "0.05700000",
"rank": "1",
"score": "1.244e+06",
"Pattern": [
{
"case": "MAX",
"eqcategory": "4",
"eqcode": "PLE_ASGMI",
"eqgroup": "C",
"ltecase": "1",
"ltecode": "ASG01",
"ltename": "相模トラフ沿いのM8クラスの地震 (領域1)",
"magnitude": "-7.9",
"pex": "3406",
"probability": "0.02097600",
"rank": "7",
"score": "9.558e+04"
},
{
"case": "MAX",
"eqcategory": "4",
"eqcode": "PLE_ASGMI",
"eqgroup": "C",
"ltecase": "1",
"ltecode": "ASG03",
"ltename": "相模トラフ沿いのM8クラスの地震 (領域3)",
"magnitude": "-8",
"pex": "13529",
"probability": "0.01704300",
"rank": "6",
"score": "7.992e+05"
},
{
"case": "MAX",
"eqcategory": "4",
"eqcode": "PLE_ASGMI",
"eqgroup": "C",
"ltecase": "1",
"ltecode": "ASG04",
"ltename": "相模トラフ沿いのM8クラスの地震 (領域4)",
"magnitude": "-8.3",
"pex": "1257",
"probability": "0.00279300",
"rank": "8",
"score": "8.665e+03"
},
{
"case": "MAX",
"eqcategory": "4",
"eqcode": "PLE_ASGMI",
"eqgroup": "C",
"ltecase": "1",
"ltecode": "ASG05",
"ltename": "相模トラフ沿いのM8クラスの地震 (領域5)",
"magnitude": "-8.4",
"pex": "58872",
"probability": "0.00159600",
"rank": "1",
"score": "3.259e+06"
},
{
"case": "MAX",
"eqcategory": "4",
"eqcode": "PLE_ASGMI",
"eqgroup": "C",
"ltecase": "1",
"ltecode": "ASG06",
"ltename": "相模トラフ沿いのM8クラスの地震 (領域6)",
"magnitude": "-8.5",
"pex": "58872",
"probability": "0.00062700",
"rank": "4",
"score": "2.243e+06"
},
{
"case": "MAX",
"eqcategory": "4",
"eqcode": "PLE_ASGMI",
"eqgroup": "C",
"ltecase": "1",
"ltecode": "ASG07",
"ltename": "相模トラフ沿いのM8クラスの地震 (領域7)",
"magnitude": "-8.5",
"pex": "59805",
"probability": "0.00062700",
"rank": "3",
"score": "2.300e+06"
},
{
"case": "MAX",
"eqcategory": "4",
"eqcode": "PLE_ASGMI",
"eqgroup": "C",
"ltecase": "1",
"ltecode": "ASG08",
"ltename": "相模トラフ沿いのM8クラスの地震 (領域8)",
"magnitude": "-8.6",
"pex": "59805",
"probability": "0.00102600",
"rank": "2",
"score": "2.801e+06"
},
{
"case": "MAX",
"eqcategory": "4",
"eqcode": "PLE_ASGMI",
"eqgroup": "C",
"ltecase": "1",
"ltecode": "ASG10",
"ltename": "相模トラフ沿いのM8クラスの地震 (領域10)",
"magnitude": "-8.2",
"pex": "35889",
"probability": "0.00239400",
"rank": "5",
"score": "1.736e+06"
}
]
}
],
"metaData": {
"areacode": "A13101",
"case": "MAX",
"ecode": "ALL_NT_A",
"ijma": "60",
"lang": "ja",
"mode": "C",
"param": "0.6",
"period": "P_T30",
"version": "Y2020"
},
"status": "Success"
}
XML形式
XML形式のレスポンスは以下の通りです。
| タグ | 説明 | ||
|---|---|---|---|
| jshis:status | ステータス
|
||
| jshis:Faults | 断層情報配列要素 | ||
| jshis:Fault | 断層情報メンバー要素 | ||
| rank | 順位 scoreの大きい順に1から増加します。 |
||
| ltecode | 断層コード
詳細は断層コード規約を参照してください。 |
||
| ltecase | 断層ケース | ||
| ltename | 断層名称 | ||
| eqcode | 地震コード
詳細は地震コード規約を参照してください。 |
||
| eqgroup | 地震グループ
|
||
| eqcategory | <2008~2019年版> 地震カテゴリー
<2020年版~>
|
||
| case | 平均/最大ケース
|
||
| probability | 発生確率 | ||
| magnitude | マグニチュード 正の場合は気象庁マグニチュードを示し、負の場合はモーメントマグニチュードを示します。 マグニチュードに範囲がある場合は、最小値と最大値をコンマ区切りで記載します。 例:マグニチュード6.0から6.5の場合…「6.0,6.5」 |
||
| score | 評価関数値 絶対値に意味はありませんが、影響が大きいほど大きな値となります。 |
||
| pex | 震度曝露人口 | ||
| jshis:Patterns | 発生パターン情報配列要素 発生パターンが考慮されている地震のみ存在します。 各要素jshis:Patternタグの詳細は発生パターン属性表を参照してください。 |
||
| jshis:metaData | メタ情報 | ||
| jshis:areacode | 総務省地方公共団体コード(5桁)+「A」の6桁
|
||
| jshis:ecode | 人口コード | ||
| jshis:mode | 想定地震コード | ||
| jshis:version | 地図バージョン | ||
| jshis:case | 確率ケース | ||
| jshis:period | 発生確率評価期間 | ||
| jshis:param | 評価パラメータ | ||
| jshis:ijma | 超過確率しきい震度 | ||
| jshis:lang | 言語 |
以下の例はXML形式レスポンスのサンプルです。
<?xml version="1.0" encoding="utf-8"?>
<jshis:FltsearchArea 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/fltsearch-area-v1.1.xsd">
<jshis:status>Success</jshis:status>
<jshis:metaData>
<jshis:areacode>A08220</jshis:areacode>
<jshis:case>AVR</jshis:case>
<jshis:ecode>ALL_NT_A</jshis:ecode>
<jshis:ijma>60</jshis:ijma>
<jshis:lang>ja</jshis:lang>
<jshis:mode>C</jshis:mode>
<jshis:param>0.6</jshis:param>
<jshis:period>P_T30</jshis:period>
<jshis:version>Y2020</jshis:version>
</jshis:metaData>
<jshis:Faults>
<jshis:Fault case="AVR" eqcategory="4" eqcode="PLE_ASGMI" eqgroup="C" ltecase="1" ltecode="ASGMI" ltename="相模トラフ沿いのM8クラスの地震" magnitude="-7.9,-8.6" pex="4677" probability="0.00800000" rank="1" score="1.080e+05">
<jshis:Patterns>
<jshis:Pattern case="AVR" eqcategory="4" eqcode="PLE_ASGMI" eqgroup="C" ltecase="1" ltecode="ASG08" ltename="相模トラフ沿いのM8クラスの地震 (領域8)" magnitude="-8.6" pex="134935" probability="0.00014400" rank="1" score="4.694e+06"/>
<jshis:Pattern case="AVR" eqcategory="4" eqcode="PLE_ASGMI" eqgroup="C" ltecase="1" ltecode="ASG07" ltename="相模トラフ沿いのM8クラスの地震 (領域7)" magnitude="-8.5" pex="134935" probability="0.00008800" rank="2" score="3.855e+06"/>
<jshis:Pattern case="AVR" eqcategory="4" eqcode="PLE_ASGMI" eqgroup="C" ltecase="1" ltecode="ASG04" ltename="相模トラフ沿いのM8クラスの地震 (領域4)" magnitude="-8.3" pex="5345" probability="0.00039200" rank="3" score="4.000e+04"/>
<jshis:Pattern case="AVR" eqcategory="4" eqcode="PLE_ASGMI" eqgroup="C" ltecase="1" ltecode="ASG05" ltename="相模トラフ沿いのM8クラスの地震 (領域5)" magnitude="-8.4" pex="5677" probability="0.00022400" rank="4" score="3.522e+04"/>
<jshis:Pattern case="AVR" eqcategory="4" eqcode="PLE_ASGMI" eqgroup="C" ltecase="1" ltecode="ASG06" ltename="相模トラフ沿いのM8クラスの地震 (領域6)" magnitude="-8.5" pex="5677" probability="0.00008800" rank="5" score="2.424e+04"/>
<jshis:Pattern case="AVR" eqcategory="4" eqcode="PLE_ASGMI" eqgroup="C" ltecase="1" ltecode="ASG02" ltename="相模トラフ沿いのM8クラスの地震 (領域2)" magnitude="-8.2" pex="2117" probability="0.00048000" rank="6" score="9.860e+03"/>
<jshis:Pattern case="AVR" eqcategory="4" eqcode="PLE_ASGMI" eqgroup="C" ltecase="1" ltecode="ASG10" ltename="相模トラフ沿いのM8クラスの地震 (領域10)" magnitude="-8.2" pex="715" probability="0.00033600" rank="7" score="1.507e+03"/>
<jshis:Pattern case="AVR" eqcategory="4" eqcode="PLE_ASGMI" eqgroup="C" ltecase="1" ltecode="ASG03" ltename="相模トラフ沿いのM8クラスの地震 (領域3)" magnitude="-8" pex="225" probability="0.00239200" rank="8" score="5.210e+02"/>
<jshis:Pattern case="AVR" eqcategory="4" eqcode="PLE_ASGMI" eqgroup="C" ltecase="1" ltecode="ASG01" ltename="相模トラフ沿いのM8クラスの地震 (領域1)" magnitude="-7.9" pex="135" probability="0.00294400" rank="9" score="2.506e+02"/>
<jshis:Pattern case="AVR" eqcategory="4" eqcode="PLE_ASGMI" eqgroup="C" ltecase="1" ltecode="ASG09" ltename="相模トラフ沿いのM8クラスの地震 (領域9)" magnitude="-7.9" pex="18" probability="0.00090400" rank="10" score="6.609e+00"/>
</jshis:Patterns>
</jshis:Fault>
<jshis:Fault case="AVR" eqcategory="3" eqcode="LND_A98F" eqgroup="A" ltecase="1" ltecode="F01482C" ltename="深谷断層・綾瀬川断層(全体が同時に活動)" magnitude="-7.5" pex="379" probability="0.00000000" rank="2" score="0.000e+00"/>
<jshis:Fault case="AVR" eqcategory="4" eqcode="PLE_AJTHK" eqgroup="C" ltecase="1" ltecode="AJTHK" ltename="日本海溝沿いの超巨大地震(東北地方太平洋沖型)" magnitude="-8.6,-9" pex="35" probability="0.00000000" rank="3" score="0.000e+00">
<jshis:Patterns>
<jshis:Pattern case="AVR" eqcategory="4" eqcode="PLE_AJTHK" eqgroup="C" ltecase="1" ltecode="AJT06" ltename="日本海溝沿いの超巨大地震(東北地方太平洋沖型)(Mw9.0モデル1)" magnitude="-9" pex="35" probability="0.00000000" rank="1" score="0.000e+00"/>
<jshis:Pattern case="AVR" eqcategory="4" eqcode="PLE_AJTHK" eqgroup="C" ltecase="1" ltecode="AJT10" ltename="日本海溝沿いの超巨大地震(東北地方太平洋沖型)(Mw8.9モデル2)" magnitude="-8.9" pex="35" probability="0.00000000" rank="2" score="0.000e+00"/>
<jshis:Pattern case="AVR" eqcategory="4" eqcode="PLE_AJTHK" eqgroup="C" ltecase="1" ltecode="AJT05" ltename="日本海溝沿いの超巨大地震(東北地方太平洋沖型)(Mw8.8モデル2)" magnitude="-8.8" pex="35" probability="0.00000000" rank="3" score="0.000e+00"/>
<jshis:Pattern case="AVR" eqcategory="4" eqcode="PLE_AJTHK" eqgroup="C" ltecase="1" ltecode="AJT09" ltename="日本海溝沿いの超巨大地震(東北地方太平洋沖型)(Mw8.7モデル3)" magnitude="-8.7" pex="35" probability="0.00000000" rank="4" score="0.000e+00"/>
</jshis:Patterns>
</jshis:Fault>
</jshis:Faults>
</jshis:FltsearchArea>
発生パターン要素リストの各要素の内容を以下に示します。
| 属性名 | 説明 |
|---|---|
| rank | 順位 発生パターン内でscoreの大きい順に1から増加します。 |
| ltecode | 断層コード
詳細は断層コード規約を参照してください。 |
| ltecase | 断層ケース名 mode=Sの場合のみ存在します。 |
| ltename | 断層名称 |
| eqcode | 地震コード
詳細は地震コード規約を参照してください。 |
| eqgroup | 地震グループ
|
| eqcategory | <2008~2019年版> 地震カテゴリー
<2020年版~>
|
| case | 平均/最大ケース
|
| probability | 発生確率 発生パターンが考慮されている地震の発生確率に、各発生パターンに付与される重みをかけた値です。 |
| magnitude | マグニチュード 正の場合は気象庁マグニチュードを示し、負の場合はモーメントマグニチュードを示します。 マグニチュードに範囲がある場合は、最小値と最大値をコンマ区切りで記載します。 例:マグニチュード6.0から6.5の場合…「6.0,6.5」 |
| score | 評価関数値 絶対値に意味はありませんが、影響が大きいほど大きな値となります。 |
| pex | 震度曝露人口 |
エラーケース
エラー分類コード
エラー分類コードは以下の通りです。
| 分類コード | 説明 |
|---|---|
| INVALID_REQUEST | 指定したリクエストに誤りがある。 |
| DB_CONNECT_ERROR | DBに関するエラーが発生した。 |
| UNKNOWN_ERROR | 未定義のエラーが発生した。 |
| NOT_FOUND | 該当するデータが存在しない。 |
JSON形式
JSON形式のリクエストでエラーが発生した場合のレスポンスは以下の通りです。
| タグ | 説明 | |
|---|---|---|
| status | ステータス
|
|
| error | エラー情報 | |
| code | エラー分類コード | |
| message | エラー内容を示すメッセージ |
以下の例はJSON形式エラーレスポンスのサンプルです。
{
"status": "Error",
"error": {
"code": "INVALID_REQUEST",
"message": "Supported formats are json,xml"
}
}
XML形式
XML形式のリクエストでエラーが発生した場合のレスポンスは以下の通りです。
| タグ | 説明 | |
|---|---|---|
| jshis:status | ステータス
|
|
| jshis:error | エラー情報 | |
| jshis:code | エラー分類コード | |
| jshis:message | エラー内容を示すメッセージ |
以下の例はXML形式エラーレスポンスのサンプルです。
<?xml version="1.0" encoding="utf-8"?>
<jshis:FltsearchArea 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/fltsearch-area-v1.0.xsd">
<jshis:status>Error</jshis:status>
<jshis:error>
<jshis:code>INVALID_REQUEST</jshis:code>
<jshis:message>Supported options for [period] are : P_T30 / P_T50 </jshis:message>
</jshis:error>
</jshis:FltsearchArea>
