ハザードカーブ情報提供API

TOP > API > ハザードカーブ情報提供API

印刷する

その他

ハザードカーブ情報提供API

指定した3次メッシュのハザードカーブ情報（強震動指標に対する超過確率）を提供します。

バージョン

1.0.0

リクエストURL

https://www.j-shis.bosai.go.jp/map/api/pshm/version/case/eqcode/t/hzcv.format?meshcode=meshcode

https://www.j-shis.bosai.go.jp/map/api/meshcode/pshm/version/case/eqcode/t/hzcv.format

https://www.j-shis.bosai.go.jp/map/api/pshm/version/case/eqcode/t/hzcv.format?position=position&epsg=epsg

リクエスト

– URL

– メッシュコード指定

– 経度緯度指定

– パラメータ

レスポンス

– ステータスコード

– 正常ケース

– JSON形式

– レスポンスサンプル

– XML形式

– レスポンスサンプル

– エラーケース

– エラー分類コード

– JSON形式

– レスポンスサンプル

– XML形式

– レスポンスサンプル

リクエスト

URL

位置はメッシュコードで指定する方法と経度緯度で指定する方法があります。URL中の太字はリクエストパラメータを示し、上付き番号はパラメータ一覧表のNoに対応します。

メッシュコード指定

https://www.j-shis.bosai.go.jp/map/api/pshm/version¹/case²/eqcode³/t⁴/hzcv.format⁵?meshcode=meshcode⁶

https://www.j-shis.bosai.go.jp/map/api/meshcode⁶/pshm/version¹/case²/eqcode³/t⁴/hzcv.format⁵

経度緯度指定

https://www.j-shis.bosai.go.jp/map/api/pshm/version^１/case²/eqcode^３/t^４/hzcv.format⁵?position=position⁷&epsg=epsg⁸

パラメータ

APIのリクエストパラメータは以下の通りです。パラメータは大文字・小文字を区別して指定して下さい。

No	パラメータ	省略可否	説明
1	version	必須	地図バージョン 2008年版…Y2008 2009年版…Y2009 2010年版…Y2010 2011年版…Y2011 2012年版（モデル1）…Y2012 2012年版（モデル2）…Y2012_M2 2013年版（モデル1）…Y2013 2013年版（モデル2）…Y2013_M2 2013年版（モデル3）…Y2013_M3 2014年版…Y2014 2016年版…Y2016 2018年版…Y2018 2019年(NIED作成版)…Y2019 2020年版…Y2020 2021年(NIED作成版)…Y2021 2022年(NIED作成版)…Y2022 2023年(NIED作成版)…Y2023 2024年(NIED作成版)…Y2024
2	case	必須	確率ケース平均ケース…AVR 最大ケース…MAX
3	eqcode	必須	地震コード詳細は地震コード規約を参照して下さい。
4	t	必須	経過年 30年…T30 50年…T50
5	format	必須	出力形式 JSON形式…json XML形式…xml
6	meshcode	positionと排他的	3次メッシュコード詳細は3次メッシュコード定義を参照して下さい。注) positionもしくはepsgが指定された場合はエラーとなります。
7	position	meshcodeと排他的	経度と緯度をコンマ区切りで指定します。指定可能範囲は以下の通りです。 122.0≦経度≦154.0 20.0≦緯度≦47.0 注1) epsg指定時は必須です。注2) meshcodeが指定された場合はエラーとなります。
8	epsg	meshcodeと排他的	EPSGコード JGD2000…4612 Tokyo…4301 WGS84…4326 注1) position指定時は必須です。注2) meshcodeが指定された場合はエラーとなります。

レスポンス

ステータスコード

データを正常に取得した場合は、HTTPステータスコードに200を設定し、正常ケースのレスポンスを返します。エラーが発生した場合は、以下のHTTPステータスコードを設定し、エラーケースのレスポンスを返します。

HTTPステータスコード	説明
400	Bad Request	リクエストURLに間違いがあることを示します。例：サポートされていない値を設定した。
403	Forbidden	リクエストが拒否されたことを示します。例：リクエストの上限を超えた。
404	Not Found	リクエストに一致するデータが1件も存在しないことを示します。例：存在しないメッシュコードを指定した。
500	Internal Server Error	内部エラーが発生したことを示します。
503	Service Unavailable	サービスが一時的に利用不可であることを示します。例：DBへの接続に失敗した。

正常ケース

JSON形式

JSON形式のレスポンスは以下の通りです。

タグ		説明
type		JSONオブジェクトタイプ PshmHzcv（固定値）
status		ステータス Success（固定値）
metaData		メタ情報
	meshcode	3次メッシュコード詳細は3次メッシュコード定義を参照して下さい。
	eqcode	地震コード
	version	地図バージョン
	case	確率ケース
	t	経過年
prob		超過確率
	meshcode	3次メッシュコード詳細は3次メッシュコード定義を参照して下さい。
	value	simに格納されている強震動指標に対する超過確率値の配列
sim		強震動指標
	type	強震動指標種類 bv…工学的基盤上の最大速度
	unit	強震動指標配列に格納した値の単位
	value	強震動指標値の配列

以下の例はJSON形式レスポンスのサンプルです。

レスポンスサンプル

リクエストURL

https://www.j-shis.bosai.go.jp/map/api/pshm/Y2010/AVR/TTL_MTTL/T30/hzcv.json?meshcode=51322041N

JSON形式レスポンス

{
    "type": "PshmHzcv",
    "status": "Success",
    "metaData": {
        "meshcode": "51322041N",
        "eqcode": "TTL_MTTL",
        "version": "Y2010",
        "case": "AVR",
        "t": "30"
    },
    "prob": {
        "meshcode": "51322041N",
        "value": [
            "1.000000",   "0.9995463",   "0.9595824",
            "0.8783311",   "0.7994685",   "0.7182883",
            "0.6308817",   "0.5406196",   "0.4532565",
            "0.3734141",   "0.3036335",   "0.2190794",
            "0.1564535",   "0.1114249",   "0.07955143",
            "0.05715077",   "0.04142031",   "0.03033558",
            "0.02247881",   "0.01685985",   "0.01280638",
            "0.008334419",   "0.005611635",   "0.003968899",
            "0.003148562",   "0.002552753",   "0.002107752",
            "0.001766375",   "0.001498294",   "0.001282806",
            "0.001106593",   "0.0008373687",   "0.0006446405",
            "0.0005003452",   "0.0003907430",   "0.0003061670",
            "0.0002406302",   "0.0001896429",   "0.0001498107",
            "0.0001185443",   "0.00009391604",   "0.00005903268",
            "0.00003698568",   "0.00002286980",   "0.00001371502",
            "0.000007703490"
        ]
    },
    "sim": {
        "type": "bv",
        "unit": "cm/s",
        "value": [
            "0.0",   "2.0",   "4.0",   "6.0",   "8.0",
            "10.0",   "12.0",   "14.0",   "16.0",
            "18.0",   "20.0",   "23.0",   "26.0",
            "29.0",   "32.0",   "35.0",   "38.0",
            "41.0",   "44.0",   "47.0",   "50.0",
            "55.0",   "60.0",   "65.0",   "70.0",
            "75.0",   "80.0",   "85.0",   "90.0",
            "95.0",   "100.0",   "110.0",   "120.0",
            "130.0",   "140.0",   "150.0",   "160.0",
            "170.0",   "180.0",   "190.0",   "200.0",
            "220.0",   "240.0",   "260.0",   "280.0",
            "300.0"
        ]
    }
}

XML形式

XML形式のレスポンスは以下の通りです。

タグ			説明
jshis: status			ステータス Success（固定値）
jshis: type			タイプ PshmHzcv（固定値）
jshis: metaData			メタ情報
	jshis: meshcode		3次メッシュコード詳細は3次メッシュコード定義を参照して下さい。
	jshis: eqcode		地震コード
	jshis: version		地図バージョン
	jshis: case		確率ケース
	jshis: t		経過年
jshis: prob			超過確率配列
	jshis: meshcode		3次メッシュコード詳細は3次メッシュコード定義を参照して下さい。
	jshis: values		超過確率
		jshis: value	属性idは対応する強震動指標値のid番号
jshis: sim			強震動指標配列。 type…強震動指標種類 bv…工学的基盤上の最大速度 unit…強震動指標配列に格納した値の単位
	jshis: values		強震動指標値
		jshis: value	属性idは対応する超過確率値のid番号

以下の例はXML形式レスポンスのサンプルです。

レスポンスサンプル

リクエストURL

https://www.j-shis.bosai.go.jp/map/api/36225725N/pshm/Y2010/AVR/TTL_MTTL/T30/hzcv.xml

XML形式レスポンス

<?xml version="1.0" encoding="utf-8"?>
<jshis:PshmHzcv 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/pshm-hzcv-v1.0.xsd">
    <jshis:status>Success</jshis:status>
    <jshis:type>PshmHzcv</jshis:type>
    <jshis:metaData>
        <jshis:meshcode>51322041N</jshis:meshcode>
        <jshis:eqcode>TTL_MTTL</jshis:eqcode>
        <jshis:version>Y2010</jshis:version>
        <jshis:case>AVR</jshis:case>
        <jshis:t>30</jshis:t>
    </jshis:metaData>
    <jshis:prob>
        <jshis:meshcode>51322041N</jshis:meshcode>
        <jshis:values>
            <jshis:value id="1">1.000000</jshis:value>
            <jshis:value id="2">0.9995463</jshis:value>
            <jshis:value id="3">0.9595824</jshis:value>
            <jshis:value id="4">0.8783311</jshis:value>
            <jshis:value id="5">0.7994685</jshis:value>
            <jshis:value id="6">0.7182883</jshis:value>
            <jshis:value id="7">0.6308817</jshis:value>
            <jshis:value id="8">0.5406196</jshis:value>
            <jshis:value id="9">0.4532565</jshis:value>
            <jshis:value id="10">0.3734141</jshis:value>
            <jshis:value id="11">0.3036335</jshis:value>
            <jshis:value id="12">0.2190794</jshis:value>
            <jshis:value id="13">0.1564535</jshis:value>
            <jshis:value id="14">0.1114249</jshis:value>
            <jshis:value id="15">0.07955143</jshis:value>
            <jshis:value id="16">0.05715077</jshis:value>
            <jshis:value id="17">0.04142031</jshis:value>
            <jshis:value id="18">0.03033558</jshis:value>
            <jshis:value id="19">0.02247881</jshis:value>
            <jshis:value id="20">0.01685985</jshis:value>
            <jshis:value id="21">0.01280638</jshis:value>
            <jshis:value id="22">0.008334419</jshis:value>
            <jshis:value id="23">0.005611635</jshis:value>
            <jshis:value id="24">0.003968899</jshis:value>
            <jshis:value id="25">0.003148562</jshis:value>
            <jshis:value id="26">0.002552753</jshis:value>
            <jshis:value id="27">0.002107752</jshis:value>
            <jshis:value id="28">0.001766375</jshis:value>
            <jshis:value id="29">0.001498294</jshis:value>
            <jshis:value id="30">0.001282806</jshis:value>
            <jshis:value id="31">0.001106593</jshis:value>
            <jshis:value id="32">0.0008373687</jshis:value>
            <jshis:value id="33">0.0006446405</jshis:value>
            <jshis:value id="34">0.0005003452</jshis:value>
            <jshis:value id="35">0.0003907430</jshis:value>
            <jshis:value id="36">0.0003061670</jshis:value>
            <jshis:value id="37">0.0002406302</jshis:value>
            <jshis:value id="38">0.0001896429</jshis:value>
            <jshis:value id="39">0.0001498107</jshis:value>
            <jshis:value id="40">0.0001185443</jshis:value>
            <jshis:value id="41">0.00009391604</jshis:value>
            <jshis:value id="42">0.00005903268</jshis:value>
            <jshis:value id="43">0.00003698568</jshis:value>
            <jshis:value id="44">0.00002286980</jshis:value>
            <jshis:value id="45">0.00001371502</jshis:value>
            <jshis:value id="46">0.000007703490</jshis:value>
        </jshis:values>
    </jshis:prob>
    <jshis:sim type="bv" unit="cm/s">
        <jshis:values>
            <jshis:value id="1">0.0</jshis:value>
            <jshis:value id="2">2.0</jshis:value>
            <jshis:value id="3">4.0</jshis:value>
            <jshis:value id="4">6.0</jshis:value>
            <jshis:value id="5">8.0</jshis:value>
            <jshis:value id="6">10.0</jshis:value>
            <jshis:value id="7">12.0</jshis:value>
            <jshis:value id="8">14.0</jshis:value>
            <jshis:value id="9">16.0</jshis:value>
            <jshis:value id="10">18.0</jshis:value>
            <jshis:value id="11">20.0</jshis:value>
            <jshis:value id="12">23.0</jshis:value>
            <jshis:value id="13">26.0</jshis:value>
            <jshis:value id="14">29.0</jshis:value>
            <jshis:value id="15">32.0</jshis:value>
            <jshis:value id="16">35.0</jshis:value>
            <jshis:value id="17">38.0</jshis:value>
            <jshis:value id="18">41.0</jshis:value>
            <jshis:value id="19">44.0</jshis:value>
            <jshis:value id="20">47.0</jshis:value>
            <jshis:value id="21">50.0</jshis:value>
            <jshis:value id="22">55.0</jshis:value>
            <jshis:value id="23">60.0</jshis:value>
            <jshis:value id="24">65.0</jshis:value>
            <jshis:value id="25">70.0</jshis:value>
            <jshis:value id="26">75.0</jshis:value>
            <jshis:value id="27">80.0</jshis:value>
            <jshis:value id="28">85.0</jshis:value>
            <jshis:value id="29">90.0</jshis:value>
            <jshis:value id="30">95.0</jshis:value>
            <jshis:value id="31">100.0</jshis:value>
            <jshis:value id="32">110.0</jshis:value>
            <jshis:value id="33">120.0</jshis:value>
            <jshis:value id="34">130.0</jshis:value>
            <jshis:value id="35">140.0</jshis:value>
            <jshis:value id="36">150.0</jshis:value>
            <jshis:value id="37">160.0</jshis:value>
            <jshis:value id="38">170.0</jshis:value>
            <jshis:value id="39">180.0</jshis:value>
            <jshis:value id="40">190.0</jshis:value>
            <jshis:value id="41">200.0</jshis:value>
            <jshis:value id="42">220.0</jshis:value>
            <jshis:value id="43">240.0</jshis:value>
            <jshis:value id="44">260.0</jshis:value>
            <jshis:value id="45">280.0</jshis:value>
            <jshis:value id="46">300.0</jshis:value>
        </jshis:values>
    </jshis:sim>
</jshis:PshmHzcv>

エラーケース

エラー分類コード

エラー分類コードは以下の通りです。

分類コード	説明
INVALID_REQUEST	指定したリクエストに誤りがある。
DB_CONNECT_ERROR	DBに関するエラーが発生した。
UNKNOWN_ERROR	未定義のエラーが発生した。
NOT_FOUND	該当するデータが存在しない。

JSON形式

JSON形式のリクエストでエラーが発生した場合のレスポンスは以下の通りです。

タグ		説明
type		JSONオブジェクトタイプ PshmHzcv（固定値）
status		ステータス Error（固定値）
error		エラー情報
	code	エラー分類コード
	message	エラー内容を示すメッセージ

以下の例はJSON形式エラーレスポンスのサンプルです。

レスポンスサンプル

リクエストURL

https://www.j-shis.bosai.go.jp/map/api/pshm/Y2010/AVR/TTL_MTTL/T60/hzcv.json?meshcode=51322041N

JSON形式エラーレスポンス

{
  "type": "PshmHzcv",
  "status": "Error",
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Supported options for [ t ] are : T30 / T50"
  }
}

XML形式

XML形式のリクエストでエラーが発生した場合のレスポンスは以下の通りです。

タグ		説明
jshis:status		ステータス Error（固定値）
jshis:error		エラー情報
	jshis:code	エラー分類コード
	jshis:message	エラー内容を示すメッセージ

以下の例はXML形式エラーレスポンスのサンプルです。

レスポンスサンプル

リクエストURL

https://www.j-shis.bosai.go.jp/map/api/51322041N/pshm/Y2010/AVR/TTL_MTTL/T60/hzcv.xml

XML形式エラーレスポンス

<jshis:PshmHzcv 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/pshm-hzcv-v1.0.xsd">
    <jshis:status>Error</jshis:status>
    <jshis:error>
        <jshis:code>INVALID_REQUEST</jshis:code>
        <jshis:message>Supported options for [ t ] are : T30 / T50</jshis:message>
    </jshis:error>
</jshis:PshmHzcv>

カテゴリー : API | タグ : ハザードカーブ　

TOP > API > ハザードカーブ情報提供API

J-SHIS | 地震ハザードステーション

ハザードカーブ情報提供API

バージョン

リクエストURL

目次

リクエスト

– URL

– メッシュコード指定

– 経度緯度指定

– パラメータ

レスポンス

– ステータスコード

– 正常ケース

– JSON形式

– XML形式

– エラーケース

– エラー分類コード

– JSON形式

– XML形式

リクエスト

URL

メッシュコード指定

経度緯度指定

パラメータ

レスポンス

ステータスコード

正常ケース

JSON形式

XML形式

エラーケース

エラー分類コード

JSON形式

XML形式