その他
地震ハザードカルテAPI
指定した250mメッシュの地震ハザードカルテを提供します。
バージョン
1.0.0
リクエストURL
https://www.j-shis.bosai.go.jp/labs/api/karte/format?version=version&meshcode=meshcode
https://www.j-shis.bosai.go.jp/labs/api/karte/format?version=version&position=position&epsg=epsg
https://www.j-shis.bosai.go.jp/labs/api/karte/version/meshcode/meshinfo.format
目次
リクエスト
– URL
– メッシュコード指定
– 経度緯度指定
– パラメータ
レスポンス
– ステータスコード
– 正常ケース
– HTML形式
– PDF形式
– エラーケース
– エラー分類コード
リクエスト
URL
位置はメッシュコードで指定する方法と経度緯度で指定する方法があります。URL中の太字はリクエストパラメータを示し、上付き番号はパラメータ一覧表のNoに対応します。
メッシュコード指定
https://www.j-shis.bosai.go.jp/labs/api/karte/format1?version=version2&meshcode=meshcode3
https://www.j-shis.bosai.go.jp/labs/api/karte/version2/meshcode3/meshinfo.format1
経度緯度指定
https://www.j-shis.bosai.go.jp/labs/api/karte/format1?version=version2&position=position4&epsg=epsg5
パラメータ
APIのリクエストパラメータは以下の通りです。パラメータは大文字・小文字を区別して指定して下さい。
| No | パラメータ | 省略可否 | 説明 |
|---|---|---|---|
| 1 | format | 必須 | 出力形式
|
| 2 | version | 必須 | 地図バージョン
|
| 3 | meshcode | positionと排他的 | 250mメッシュコード
詳細はこちらを参照して下さい。 注) positionもしくはepsgが指定された場合はエラーとなります。 |
| 4 | position | meshcodeと排他的 | 経度と緯度をコンマ区切りで指定します。指定可能範囲は以下の通りです。
注1) epsg指定時は必須です。 |
| 5 | 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への接続に失敗した。 |
正常ケース
地震ハザードカルテの内容の詳細はこちらをご覧ください。
HTML形式
レスポンスサンプル
リクエストURL
https://www.j-shis.bosai.go.jp/labs/api/karte/Y2020/5339452532/meshinfo.html
HTML形式レスポンス
HTML形式レスポンス例
PDF形式
以下の例はPDF形式レスポンスのサンプルです。
レスポンスサンプル
リクエストURL
https://www.j-shis.bosai.go.jp/labs/api/karte/Y2020/5339452532/meshinfo.pdf
PDF形式レスポンス
PDF形式レスポンス例
エラーケース
エラー分類コード
エラー分類コードは以下の通りです。
| 分類コード | 説明 |
|---|---|
| INVALID_REQUEST | 指定したリクエストに誤りがある。 |
| DB_CONNECT_ERROR | DBに関するエラーが発生した。 |
| UNKNOWN_ERROR | 未定義のエラーが発生した。 |
| NOT_FOUND | 該当するデータが存在しない。 |
以下の例はエラーレスポンスのサンプルです。
レスポンスサンプル
リクエストURL
https://www.j-shis.bosai.go.jp/labs/api/karte/Y2020/53394525/meshinfo.pdf
エラーレスポンス
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US" xml:lang="en-US">
<head>
<title>診断結果</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
</head>
<body>
<p>指定した地点の地震ハザード情報はありません。</p>
</body>
</html>
