ハザードカーブ情報提供API
バージョン
リクエストURL
目次
リクエスト
– URL
– メッシュコード指定
– 経度緯度指定
– パラメータ
レスポンス
– ステータスコード
– 正常ケース
– JSON形式
– XML形式
– エラーケース
– エラー分類コード
– JSON形式
– XML形式
リクエスト
URL
位置はメッシュコードで指定する方法と経度緯度で指定する方法があります。URL中の太字はリクエストパラメータを示し、上付き番号はパラメータ一覧表のNoに対応します。
メッシュコード指定
経度緯度指定
パラメータ
APIのリクエストパラメータは以下の通りです。パラメータは大文字・小文字を区別して指定して下さい。
No | パラメータ | 省略可否 | 説明 |
---|---|---|---|
1 | version | 必須 | 地図バージョン
|
2 | case | 必須 | 確率ケース
|
3 | eqcode | 必須 | 地震コード
詳細は地震コード規約を参照して下さい。 |
4 | t | 必須 | 経過年
|
5 | format | 必須 | 出力形式
|
6 | meshcode | positionと排他的 | 3次メッシュコード
詳細は3次メッシュコード定義を参照して下さい。 注) positionもしくはepsgが指定された場合はエラーとなります。 |
7 | position | meshcodeと排他的 | 経度と緯度をコンマ区切りで指定します。指定可能範囲は以下の通りです。
注1) epsg指定時は必須です。 |
8 | epsg | meshcodeと排他的 | EPSGコード
注1) position指定時は必須です。 |
レスポンス
ステータスコード
データを正常に取得した場合は、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オブジェクトタイプ
|
|
status | ステータス
|
|
metaData | メタ情報 | |
meshcode | 3次メッシュコード
詳細は3次メッシュコード定義を参照して下さい。 |
|
eqcode | 地震コード | |
version | 地図バージョン | |
case | 確率ケース | |
t | 経過年 | |
prob | 超過確率 | |
meshcode | 3次メッシュコード
詳細は3次メッシュコード定義を参照して下さい。 |
|
value | simに格納されている強震動指標に対する超過確率値の配列 | |
sim | 強震動指標 | |
type | 強震動指標種類
|
|
unit | 強震動指標配列に格納した値の単位 | |
value | 強震動指標値の配列 |
以下の例は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 |
ステータス
|
||
jshis: type |
タイプ
|
||
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 |
強震動指標配列。
|
||
jshis: values |
強震動指標値 | ||
jshis: value |
属性idは対応する超過確率値のid番号 |
以下の例は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オブジェクトタイプ
|
|
status | ステータス
|
|
error | エラー情報 | |
code | エラー分類コード | |
message | エラー内容を示すメッセージ |
以下の例はJSON形式エラーレスポンスのサンプルです。
{ "type": "PshmHzcv", "status": "Error", "error": { "code": "INVALID_REQUEST", "message": "Supported options for [ t ] are : T30 / T50" } }
XML形式
XML形式のリクエストでエラーが発生した場合のレスポンスは以下の通りです。
タグ | 説明 | |
---|---|---|
jshis:status | ステータス
|
|
jshis:error | エラー情報 | |
jshis:code | エラー分類コード | |
jshis:message | エラー内容を示すメッセージ |
以下の例は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>