その他
深部物性値情報提供API
深部物性値情報を提供します。
バージョン
1.0.0
リクエストURL
https://www.j-shis.bosai.go.jp/map/api/dstrct/version/phys.format
目次
リクエスト
– URL
– パラメータ
レスポンス
– ステータスコード
– 正常ケース
– JSON形式
– XML形式
– エラーケース
– エラー分類コード
– JSON形式
– XML形式
リクエスト
URL
URL中の太字はリクエストパラメータを示し、上付き番号はパラメータ一覧表のNoに対応します。
https://www.j-shis.bosai.go.jp/map/api/dstrct/version1/phys.format2
パラメータ
APIのリクエストパラメータは以下の通りです。パラメータは大文字・小文字を区別して指定して下さい。
No | パラメータ | 省略可否 | 説明 |
---|---|---|---|
1 | version | 必須 | バージョンコード
詳細はバージョンコード一覧を参照して下さい。 |
2 | format | 必須 | 出力形式
|
バージョンコードの一覧を以下に示します。
バージョンコード | 概要 |
---|---|
V1 | 藤原広行・河合伸一・青井真・森川信之・先名重樹・工藤暢章・大井昌弘・はお憲生・早川讓・遠山信彦・松山尚典・岩本鋼司・鈴木晴彦・劉瑛(2009): 強震動評価のための全国深部地盤構造モデル作成手法の検討, 防災科学技術研究所研究資料 第337号 のデータ(注1) |
V2 | 藤原広行・河合伸一・青井真・森川信之・先名重樹・東宏樹・大井昌弘・はお憲生・長谷川信介・前田宜浩・岩城麻子・若松加寿江・井元政二郎・奥村俊彦・松山尚典・成田章 (2012) : 東日本大震災を踏まえた地震ハザード評価の改良に向けた検討, 防災科学技術研究所研究資料 第379号 のデータ(注1) |
V3.2 | 地震調査研究推進本部(2021): 関東地方の浅部・深部統合地盤構造モデル(2021 年版)のデータ |
注1) 関連文献リストからダウンロードすることができます。
レスポンス
ステータスコード
データを正常に取得した場合は、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 | ステータス
|
||
phys | 物性値属性の配列 | ||
SVP | P波速度の連想配列 | ||
tn1 | 1層目のP波速度 | ||
tn2 | 2層目のP波速度 | ||
・・・ | ・・・ | ||
tn33 | 33層目のP波速度 | ||
SVS | S波速度の連想配列 | ||
tn1 | 1層目のS波速度 | ||
tn2 | 2層目のS波速度 | ||
・・・ | ・・・ | ||
tn33 | 33層目のS波速度 | ||
SRO | 密度の連想配列 | ||
tn1 | 1層目の密度 | ||
tn2 | 2層目の密度 | ||
・・・ | ・・・ | ||
tn33 | 33層目の密度 | ||
SQP | Qpの連想配列 | ||
tn1 | 1層目のQp | ||
tn2 | 2層目のQp | ||
・・・ | ・・・ | ||
tn33 | 33層目のQp | ||
SQS | Qsの連想配列 | ||
tn1 | 1層目のQs | ||
tn2 | 2層目のQs | ||
・・・ | ・・・ | ||
tn33 | 33層目のQs | ||
metaData | メタ情報 | ||
version | バージョンコード | ||
phys | レスポンスに含まれる物性値属性 | ||
name | 物性値属性名 | ||
unit | 物性値の単位 |
以下の例はJSON形式レスポンスのサンプルです。
レスポンスサンプル
リクエストURL
https://www.j-shis.bosai.go.jp/map/api/dstrct/V1/phys.json
JSON形式レスポンス
{ "status": "Success", "phys": { "SVP": { "tn1" :"1600", "tn2" :"1600", "tn3" :"1700", "tn4" :"1800", "tn5" :"1800", "tn6" :"2000", "tn7" :"2000", "tn8" :"2100", "tn9" :"2100", "tn10":"2200", "tn11":"2300", "tn12":"2400", "tn13":"2400", "tn14":"2500", "tn15":"2500", "tn16":"2600", "tn17":"2700", "tn18":"3000", "tn19":"3200", "tn20":"3400", "tn21":"3500", "tn22":"3600", "tn23":"3700", "tn24":"3800", "tn25":"4000", "tn26":"4000", "tn27":"5000", "tn28":"4600", "tn29":"5000", "tn30":"5500", "tn31":"5500", "tn32":"5700", "tn33":"6000" }, "SVS": { "tn1" :"350", "tn2" :"400", "tn3" :"450", "tn4" :"500", "tn5" :"550", "tn6" :"600", "tn7" :"650", "tn8" :"700", "tn9" :"750", "tn10":"800", "tn11":"850", "tn12":"900", "tn13":"950", "tn14":"1000", "tn15":"1100", "tn16":"1200", "tn17":"1300", "tn18":"1400", "tn19":"1500", "tn20":"1600", "tn21":"1700", "tn22":"1800", "tn23":"1900", "tn24":"2000", "tn25":"2100", "tn26":"2100", "tn27":"2700", "tn28":"2900", "tn29":"2700", "tn30":"3100", "tn31":"3200", "tn32":"3300", "tn33":"3400" }, "SRO": { "tn1" :"1850", "tn2" :"1850", "tn3" :"1900", "tn4" :"1900", "tn5" :"1900", "tn6" :"1900", "tn7" :"1950", "tn8" :"2000", "tn9" :"2000", "tn10":"2000", "tn11":"2050", "tn12":"2050", "tn13":"2100", "tn14":"2100", "tn15":"2150", "tn16":"2150", "tn17":"2200", "tn18":"2250", "tn19":"2250", "tn20":"2300", "tn21":"2300", "tn22":"2350", "tn23":"2350", "tn24":"2400", "tn25":"2400", "tn26":"2400", "tn27":"2500", "tn28":"2550", "tn29":"2500", "tn30":"2600", "tn31":"2650", "tn32":"2700", "tn33":"2750" }, "SQP": { "tn1" :"60", "tn2" :"60", "tn3" :"60", "tn4" :"60", "tn5" :"60", "tn6" :"100", "tn7" :"100", "tn8" :"100", "tn9" :"100", "tn10":"100", "tn11":"100", "tn12":"100", "tn13":"100", "tn14":"150", "tn15":"150", "tn16":"150", "tn17":"150", "tn18":"150", "tn19":"150", "tn20":"150", "tn21":"150", "tn22":"150", "tn23":"150", "tn24":"200", "tn25":"200", "tn26":"200", "tn27":"200", "tn28":"200", "tn29":"200", "tn30":"300", "tn31":"300", "tn32":"300", "tn33":"300" }, "SQS": { "tn1" :"60", "tn2" :"60", "tn3" :"60", "tn4" :"60", "tn5" :"60", "tn6" :"100", "tn7" :"100", "tn8" :"100", "tn9" :"100", "tn10":"100", "tn11":"100", "tn12":"100", "tn13":"100", "tn14":"150", "tn15":"150", "tn16":"150", "tn17":"150", "tn18":"150", "tn19":"150", "tn20":"150", "tn21":"150", "tn22":"150", "tn23":"150", "tn24":"200", "tn25":"200", "tn26":"200", "tn27":"200", "tn28":"200", "tn29":"200", "tn30":"300", "tn31":"300", "tn32":"300", "tn33":"300" } }, "metaData": { "version":"V1", "phys": [ { "name": "SVP", "unit": "m/s" }, { "name": "SVS", "unit": "m/s" }, { "name": "SRO", "unit": "kg/m^3" }, { "name": "SQP", "unit": "" }, { "name": "SQS", "unit": "" } ] } }
XML形式
XML形式のレスポンスは以下の通りです。
タグ | 説明 | |||
---|---|---|---|---|
jshis: status |
ステータス
|
|||
jshis: phys |
物性値属性の配列 | |||
jshis: SVP |
P波速度の連想配列 | |||
tn1 | 1層目のP波速度 | |||
tn2 | 2層目のP波速度 | |||
・・・ | ・・・ | |||
tn33 | 33層目のP波速度 | |||
jshis: SVS |
S波速度の連想配列 | |||
tn1 | 1層目のS波速度 | |||
tn2 | 2層目のS波速度 | |||
・・・ | ・・・ | |||
tn33 | 33層目のS波速度 | |||
jshis: SRO |
密度の連想配列 | |||
tn1 | 1層目の密度 | |||
tn2 | 2層目の密度 | |||
・・・ | ・・・ | |||
tn33 | 33層目の密度 | |||
jshis: SQP |
Qpの連想配列 | |||
tn1 | 1層目のQp | |||
tn2 | 2層目のQp | |||
・・・ | ・・・ | |||
tn33 | 33層目のQp | |||
jshis: SQS |
Qsの連想配列 | |||
tn1 | 1層目のQs | |||
tn2 | 2層目のQs | |||
・・・ | ・・・ | |||
tn33 | 33層目のQs | |||
jshis: metaData |
メタ情報 | |||
jshis: version |
バージョンコード | |||
jshis: physs |
レスポンスに含まれる物性値属性の配列 | |||
jshis: phys |
レスポンスに含まれる物性値属性 | |||
jshis: name |
物性値属性名 | |||
jshis: unit |
物性値の単位 |
以下の例はXML形式レスポンスのサンプルです。
レスポンスサンプル
リクエストURL
https://www.j-shis.bosai.go.jp/map/api/dstrct/V1/phys.xml
XML形式レスポンス
<?xml version="1.0" encoding="UTF-8"?> <jshis:DstrctPhys 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/dstrct-phys-v1.0.xsd"> <jshis:status>Success</jshis:status> <jshis:phys> <jshis:SVP> <jshis:tn1>1600</jshis:tn1><jshis:tn2>1600</jshis:tn2><jshis:tn3>1700</jshis:tn3> <jshis:tn4>1800</jshis:tn4><jshis:tn5>1800</jshis:tn5><jshis:tn6>2000</jshis:tn6> <jshis:tn7>2000</jshis:tn7><jshis:tn8>2100</jshis:tn8><jshis:tn9>2100</jshis:tn9> <jshis:tn10>2200</jshis:tn10><jshis:tn11>2300</jshis:tn11><jshis:tn12>2400</jshis:tn12> <jshis:tn13>2400</jshis:tn13><jshis:tn14>2500</jshis:tn14><jshis:tn15>2500</jshis:tn15> <jshis:tn16>2600</jshis:tn16><jshis:tn17>2700</jshis:tn17><jshis:tn18>3000</jshis:tn18> <jshis:tn19>3200</jshis:tn19><jshis:tn20>3400</jshis:tn20><jshis:tn21>3500</jshis:tn21> <jshis:tn22>3600</jshis:tn22><jshis:tn23>3700</jshis:tn23><jshis:tn24>3800</jshis:tn24> <jshis:tn25>4000</jshis:tn25><jshis:tn26>4000</jshis:tn26><jshis:tn27>5000</jshis:tn27> <jshis:tn28>4600</jshis:tn28><jshis:tn29>5000</jshis:tn29><jshis:tn30>5500</jshis:tn30> <jshis:tn31>5500</jshis:tn31><jshis:tn32>5700</jshis:tn32><jshis:tn33>6000</jshis:tn33> </jshis:SVP> <jshis:SVS> <jshis:tn1>350</jshis:tn1><jshis:tn2>400</jshis:tn2><jshis:tn3>450</jshis:tn3> <jshis:tn4>500</jshis:tn4><jshis:tn5>550</jshis:tn5><jshis:tn6>600</jshis:tn6> <jshis:tn7>650</jshis:tn7><jshis:tn8>700</jshis:tn8><jshis:tn9>750</jshis:tn9> <jshis:tn10>800</jshis:tn10><jshis:tn11>850</jshis:tn11><jshis:tn12>900</jshis:tn12> <jshis:tn13>950</jshis:tn13><jshis:tn14>1000</jshis:tn14><jshis:tn15>1100</jshis:tn15> <jshis:tn16>1200</jshis:tn16><jshis:tn17>1300</jshis:tn17><jshis:tn18>1400</jshis:tn18> <jshis:tn19>1500</jshis:tn19><jshis:tn20>1600</jshis:tn20><jshis:tn21>1700</jshis:tn21> <jshis:tn22>1800</jshis:tn22><jshis:tn23>1900</jshis:tn23><jshis:tn24>2000</jshis:tn24> <jshis:tn25>2100</jshis:tn25><jshis:tn26>2100</jshis:tn26><jshis:tn27>2700</jshis:tn27> <jshis:tn28>2900</jshis:tn28><jshis:tn29>2700</jshis:tn29><jshis:tn30>3100</jshis:tn30> <jshis:tn31>3200</jshis:tn31><jshis:tn32>3300</jshis:tn32><jshis:tn33>3400</jshis:tn33> </jshis:SVS> <jshis:SRO> <jshis:tn1>1850</jshis:tn1><jshis:tn2>1850</jshis:tn2><jshis:tn3>1900</jshis:tn3> <jshis:tn4>1900</jshis:tn4><jshis:tn5>1900</jshis:tn5><jshis:tn6>1900</jshis:tn6> <jshis:tn7>1950</jshis:tn7><jshis:tn8>2000</jshis:tn8><jshis:tn9>2000</jshis:tn9> <jshis:tn10>2000</jshis:tn10><jshis:tn11>2050</jshis:tn11><jshis:tn12>2050</jshis:tn12> <jshis:tn13>2100</jshis:tn13><jshis:tn14>2100</jshis:tn14><jshis:tn15>2150</jshis:tn15> <jshis:tn16>2150</jshis:tn16><jshis:tn17>2200</jshis:tn17><jshis:tn18>2250</jshis:tn18> <jshis:tn19>2250</jshis:tn19><jshis:tn20>2300</jshis:tn20><jshis:tn21>2300</jshis:tn21> <jshis:tn22>2350</jshis:tn22><jshis:tn23>2350</jshis:tn23><jshis:tn24>2400</jshis:tn24> <jshis:tn25>2400</jshis:tn25><jshis:tn26>2400</jshis:tn26><jshis:tn27>2500</jshis:tn27> <jshis:tn28>2550</jshis:tn28><jshis:tn29>2500</jshis:tn29><jshis:tn30>2600</jshis:tn30> <jshis:tn31>2650</jshis:tn31><jshis:tn32>2700</jshis:tn32><jshis:tn33>2750</jshis:tn33> </jshis:SRO> <jshis:SQP> <jshis:tn1>60</jshis:tn1><jshis:tn2>60</jshis:tn2><jshis:tn3>60</jshis:tn3> <jshis:tn4>60</jshis:tn4><jshis:tn5>60</jshis:tn5><jshis:tn6>100</jshis:tn6> <jshis:tn7>100</jshis:tn7><jshis:tn8>100</jshis:tn8><jshis:tn9>100</jshis:tn9> <jshis:tn10>100</jshis:tn10><jshis:tn11>100</jshis:tn11><jshis:tn12>100</jshis:tn12> <jshis:tn13>100</jshis:tn13><jshis:tn14>150</jshis:tn14><jshis:tn15>150</jshis:tn15> <jshis:tn16>150</jshis:tn16><jshis:tn17>150</jshis:tn17><jshis:tn18>150</jshis:tn18> <jshis:tn19>150</jshis:tn19><jshis:tn20>150</jshis:tn20><jshis:tn21>150</jshis:tn21> <jshis:tn22>150</jshis:tn22><jshis:tn23>150</jshis:tn23><jshis:tn24>200</jshis:tn24> <jshis:tn25>200</jshis:tn25><jshis:tn26>200</jshis:tn26><jshis:tn27>200</jshis:tn27> <jshis:tn28>200</jshis:tn28><jshis:tn29>200</jshis:tn29><jshis:tn30>300</jshis:tn30> <jshis:tn31>300</jshis:tn31><jshis:tn32>300</jshis:tn32><jshis:tn33>300</jshis:tn33> </jshis:SQP> <jshis:SQS> <jshis:tn1>60</jshis:tn1><jshis:tn2>60</jshis:tn2><jshis:tn3>60</jshis:tn3> <jshis:tn4>60</jshis:tn4><jshis:tn5>60</jshis:tn5><jshis:tn6>100</jshis:tn6> <jshis:tn7>100</jshis:tn7><jshis:tn8>100</jshis:tn8><jshis:tn9>100</jshis:tn9> <jshis:tn10>100</jshis:tn10><jshis:tn11>100</jshis:tn11><jshis:tn12>100</jshis:tn12> <jshis:tn13>100</jshis:tn13><jshis:tn14>150</jshis:tn14><jshis:tn15>150</jshis:tn15> <jshis:tn16>150</jshis:tn16><jshis:tn17>150</jshis:tn17><jshis:tn18>150</jshis:tn18> <jshis:tn19>150</jshis:tn19><jshis:tn20>150</jshis:tn20><jshis:tn21>150</jshis:tn21> <jshis:tn22>150</jshis:tn22><jshis:tn23>150</jshis:tn23><jshis:tn24>200</jshis:tn24> <jshis:tn25>200</jshis:tn25><jshis:tn26>200</jshis:tn26><jshis:tn27>200</jshis:tn27> <jshis:tn28>200</jshis:tn28><jshis:tn29>200</jshis:tn29><jshis:tn30>300</jshis:tn30> <jshis:tn31>300</jshis:tn31><jshis:tn32>300</jshis:tn32><jshis:tn33>300</jshis:tn33> </jshis:SQS> </jshis:phys> <jshis:metaData> <jshis:version>V1</jshis:version> <jshis:physs> <jshis:phys> <jshis:name>SVP</jshis:name> <jshis:unit>m/s</jshis:unit> </jshis:phys> <jshis:phys> <jshis:name>SVS</jshis:name> <jshis:unit>m/s</jshis:unit> </jshis:phys> <jshis:phys> <jshis:name>SRO</jshis:name> <jshis:unit>kg/m^3</jshis:unit> </jshis:phys> <jshis:phys> <jshis:name>SQP</jshis:name> <jshis:unit/> </jshis:phys> <jshis:phys> <jshis:name>SQS</jshis:name> <jshis:unit/> </jshis:phys> </jshis:physs> </jshis:metaData> </jshis:DstrctPhys>
エラーケース
エラー分類コード
エラー分類コードは以下の通りです。
分類コード | 説明 |
---|---|
INVALID_REQUEST | 指定したリクエストに誤りがある。 |
DB_CONNECT_ERROR | DBに関するエラーが発生した。 |
UNKNOWN_ERROR | 未定義のエラーが発生した。 |
NOT_FOUND | 該当するデータが存在しない。 |
JSON形式
JSON形式のリクエストでエラーが発生した場合のレスポンスは以下の通りです。
タグ | 説明 | |
---|---|---|
status | ステータス
|
|
error | エラー情報 | |
code | エラー分類コード | |
message | エラー内容を示すメッセージ |
以下の例はJSON形式エラーレスポンスのサンプルです。
レスポンスサンプル
リクエストURL
https://www.j-shis.bosai.go.jp/map/api/dstrct/V10/phys.json
JSON形式エラーレスポンス
{ "status": "Error", "error": { "code": "INVALID_REQUEST", "message": "Supported options for [version] are : V1 / V2 / V3.2 " } }
XML形式
XML形式のリクエストでエラーが発生した場合のレスポンスは以下の通りです。
タグ | 説明 | |
---|---|---|
jshis:status | ステータス
|
|
jshis:error | エラー情報 | |
jshis:code | エラー分類コード | |
jshis:message | エラー内容を示すメッセージ |
以下の例はXML形式エラーレスポンスのサンプルです。
レスポンスサンプル
リクエストURL
https://www.j-shis.bosai.go.jp/map/api/dstrct/V10/phys.xml
XML形式エラーレスポンス
<?xml version="1.0" encoding="utf-8"?> <jshis:DstrctPhys 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/dstrct-phys-v1.0.xsd"> <jshis:status>Error</jshis:status> <jshis:error> <jshis:code>INVALID_REQUEST</jshis:code> <jshis:message>Supported options for [version] are : V1 / V2 / V3.2 </jshis:message> </jshis:error> </jshis:DstrctPhys>