その他
表層地盤物性値情報提供API
微地形区分コードと微地形区分名称を提供します。
バージョン
1.0.0
リクエストURL
https://www.j-shis.bosai.go.jp/map/api/sstrct/version/phys.format
目次
リクエスト
– URL
– パラメータ
レスポンス
– ステータスコード
– 正常ケース
– JSON形式
– XML形式
– エラーケース
– エラー分類コード
– JSON形式
– XML形式
リクエスト
URL
URL中の太字はリクエストパラメータを示し、上付き番号はパラメータ一覧表のNoに対応します。
https://www.j-shis.bosai.go.jp/map/api/sstrct/version1/phys.format2
パラメータ
APIのリクエストパラメータは以下の通りです。パラメータは大文字・小文字を区別して指定して下さい。
No | パラメータ | 省略可否 | 説明 |
---|---|---|---|
1 | version | 必須 | 表層地盤データのバージョンコード
詳細はバージョンコード一覧を参照して下さい。 |
2 | format | 必須 | 出力形式
|
バージョンコードの一覧を以下に示します。
バージョンコード | 概要 |
---|---|
V1 | 2005 年~2008 年の「確率論的地震動予測地図」で使用した、3 次メッシュ単位データを 16 分割し 250m メッシュ単位に変換したデータ |
V2 | 2009 年の「全国地震動予測地図」で使用した、250m メッシュ単位データ |
V3 | 2014 年の「全国地震動予測地図」で使用した、250m メッシュ単位データ |
V4 | 2020 年の「全国地震動予測地図」で使用した、250m メッシュ単位データ |
レスポンス
ステータスコード
データを正常に取得した場合は、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 | 物性値属性 微地形区分の配列 |
|
jcode | 微地形区分コード | |
name_ja | 微地形区分名(日本語) | |
name_en | 微地形区分名(英語) | |
metaData | メタ情報 | |
version | バージョンコード |
以下の例はJSON形式レスポンスのサンプルです。
https://www.j-shis.bosai.go.jp/map/api/sstrct/V2/phys.json
{ "status":"Success", "phys":[ {"jcode":"1","name_ja":"山地","name_en":"Mountain"}, {"jcode":"2","name_ja":"山麓地","name_en":"Mountain footslope"}, {"jcode":"3","name_ja":"丘陵","name_en":"Hill"}, {"jcode":"4","name_ja":"火山地","name_en":"Volcano"}, {"jcode":"5","name_ja":"火山山麓地","name_en":"Volcanic footslope"}, {"jcode":"6","name_ja":"火山性丘陵","name_en":"Volcanic hill"}, {"jcode":"7","name_ja":"岩石台地","name_en":"Rocky strath terrace"}, {"jcode":"8","name_ja":"砂礫質台地","name_en":"Gravelly terrace"}, {"jcode":"9","name_ja":"ローム台地","name_en":"Terrace covered with volcanic ashsoil"}, {"jcode":"10","name_ja":"谷底低地","name_en":"Valley bottom lowland"}, {"jcode":"11","name_ja":"扇状地","name_en":"Alluvial fan"}, {"jcode":"12","name_ja":"自然堤防","name_en":"Natural levee"}, {"jcode":"13","name_ja":"後背湿地","name_en":"Back marsh"}, {"jcode":"14","name_ja":"旧河道","name_en":"Abandoned river channel"}, {"jcode":"15","name_ja":"三角州・海岸低地","name_en":"Delta and coastal lowland"}, {"jcode":"16","name_ja":"砂州・砂礫州","name_en":"Marine sand and gravel bars"}, {"jcode":"17","name_ja":"砂丘","name_en":"Sand dune"}, {"jcode":"18","name_ja":"砂州・砂丘間低地","name_en":"Lowland between coastal dunes and/or bars"}, {"jcode":"19","name_ja":"干拓地","name_en":"Reclaimed land"}, {"jcode":"20","name_ja":"埋立地","name_en":"Filled land"}, {"jcode":"21","name_ja":"磯・岩礁","name_en":"Rock shore,rockreef"}, {"jcode":"22","name_ja":"河原","name_en":"Dry river bed"}, {"jcode":"23","name_ja":"河道","name_en":"River bed"}, {"jcode":"24","name_ja":"湖沼","name_en":"Water body"} ], "metaData":{ "version":"V2" } }
XML形式
XML形式のレスポンスは以下の通りです。
タグ | 説明 | ||
---|---|---|---|
jshis:status | ステータス
|
||
jshis:physs | 物性値属性の配列 | ||
jshis:phys | 物性値属性 微地形区分の配列 |
||
jshis:jcode | 微地形区分コード | ||
jshis:name_ja | 微地形区分名(日本語) | ||
jshis:name_en | 微地形区分名(英語) | ||
jshis:metaData | メタ情報 | ||
jshis:version | バージョンコード |
以下の例はXML形式レスポンスのサンプルです。
https://www.j-shis.bosai.go.jp/map/api/sstrct/V2/phys.xml
<?xml version="1.0" encoding="utf-8"?> <jshis:SstrctPhys 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/sstrct-phys-v1.0.xsd"> <jshis:status>Success</jshis:status> <jshis:physs> <jshis:phys> <jshis:jcode>1</jshis:jcode> <jshis:name_ja>山地</jshis:name_ja> <jshis:name_en>Mountain</jshis:name_en> </jshis:phys> <jshis:phys> <jshis:jcode>2</jshis:jcode> <jshis:name_ja>山麓地</jshis:name_ja> <jshis:name_en>Mountain footslope</jshis:name_en> </jshis:phys> <jshis:phys> <jshis:jcode>3</jshis:jcode> <jshis:name_ja>丘陵</jshis:name_ja> <jshis:name_en>Hill</jshis:name_en> </jshis:phys> <jshis:phys> <jshis:jcode>4</jshis:jcode> <jshis:name_ja>火山地</jshis:name_ja> <jshis:name_en>Volcano</jshis:name_en> </jshis:phys> <jshis:phys> <jshis:jcode>5</jshis:jcode> <jshis:name_ja>火山山麓地</jshis:name_ja> <jshis:name_en>Volcanic footslope</jshis:name_en> </jshis:phys> <jshis:phys> <jshis:jcode>6</jshis:jcode> <jshis:name_ja>火山性丘陵</jshis:name_ja> <jshis:name_en>Volcanic hill</jshis:name_en> </jshis:phys> <jshis:phys> <jshis:jcode>7</jshis:jcode> <jshis:name_ja>岩石台地</jshis:name_ja> <jshis:name_en>Rocky strath terrace</jshis:name_en> </jshis:phys> <jshis:phys> <jshis:jcode>8</jshis:jcode> <jshis:name_ja>砂礫質台地</jshis:name_ja> <jshis:name_en>Gravelly terrace</jshis:name_en> </jshis:phys> <jshis:phys> <jshis:jcode>9</jshis:jcode> <jshis:name_ja>ローム台地</jshis:name_ja> <jshis:name_en>Terrace covered with volcanic ashsoil</jshis:name_en> </jshis:phys> <jshis:phys> <jshis:jcode>10</jshis:jcode> <jshis:name_ja>谷底低地</jshis:name_ja> <jshis:name_en>Valley bottom lowland</jshis:name_en> </jshis:phys> <jshis:phys> <jshis:jcode>11</jshis:jcode> <jshis:name_ja>扇状地</jshis:name_ja> <jshis:name_en>Alluvial fan</jshis:name_en> </jshis:phys> <jshis:phys> <jshis:jcode>12</jshis:jcode> <jshis:name_ja>自然堤防</jshis:name_ja> <jshis:name_en>Natural levee</jshis:name_en> </jshis:phys> <jshis:phys> <jshis:jcode>13</jshis:jcode> <jshis:name_ja>後背湿地</jshis:name_ja> <jshis:name_en>Back marsh</jshis:name_en> </jshis:phys> <jshis:phys> <jshis:jcode>14</jshis:jcode> <jshis:name_ja>旧河道</jshis:name_ja> <jshis:name_en>Abandoned river channel</jshis:name_en> </jshis:phys> <jshis:phys> <jshis:jcode>15</jshis:jcode> <jshis:name_ja>三角州・海岸低地</jshis:name_ja> <jshis:name_en>Delta and coastal lowland</jshis:name_en> </jshis:phys> <jshis:phys> <jshis:jcode>16</jshis:jcode> <jshis:name_ja>砂州・砂礫州</jshis:name_ja> <jshis:name_en>Marine sand and gravel bars</jshis:name_en> </jshis:phys> <jshis:phys> <jshis:jcode>17</jshis:jcode> <jshis:name_ja>砂丘</jshis:name_ja> <jshis:name_en>Sand dune</jshis:name_en> </jshis:phys> <jshis:phys> <jshis:jcode>18</jshis:jcode> <jshis:name_ja>砂州・砂丘間低地</jshis:name_ja> <jshis:name_en>Lowland between coastal dunes and/or bars</jshis:name_en> </jshis:phys> <jshis:phys> <jshis:jcode>19</jshis:jcode> <jshis:name_ja>干拓地</jshis:name_ja> <jshis:name_en>Reclaimed land</jshis:name_en> </jshis:phys> <jshis:phys> <jshis:jcode>20</jshis:jcode> <jshis:name_ja>埋立地</jshis:name_ja> <jshis:name_en>Filled land</jshis:name_en> </jshis:phys> <jshis:phys> <jshis:jcode>21</jshis:jcode> <jshis:name_ja>磯・岩礁</jshis:name_ja> <jshis:name_en>Rock shore,rockreef</jshis:name_en> </jshis:phys> <jshis:phys> <jshis:jcode>22</jshis:jcode> <jshis:name_ja>河原</jshis:name_ja> <jshis:name_en>Dry river bed</jshis:name_en> </jshis:phys> <jshis:phys> <jshis:jcode>23</jshis:jcode> <jshis:name_ja>河道</jshis:name_ja> <jshis:name_en>River bed</jshis:name_en> </jshis:phys> <jshis:phys> <jshis:jcode>24</jshis:jcode> <jshis:name_ja>湖沼</jshis:name_ja> <jshis:name_en>Water body</jshis:name_en> </jshis:phys> </jshis:physs> <jshis:metaData> <jshis:version>V2</jshis:version> </jshis:metaData> </jshis:SstrctPhys>
エラーケース
エラー分類コード
エラー分類コードは以下の通りです。
分類コード | 説明 |
---|---|
INVALID_REQUEST | 指定したリクエストに誤りがある。 |
DB_CONNECT_ERROR | DBに関するエラーが発生した。 |
UNKNOWN_ERROR | 未定義のエラーが発生した。 |
NOT_FOUND | 該当するデータが存在しない。 |
JSON形式
JSON形式のリクエストでエラーが発生した場合のレスポンスは以下の通りです。
タグ | 説明 | |
---|---|---|
status | ステータス
|
|
error | エラー情報 | |
code | エラー分類コード | |
message | エラー内容を示すメッセージ |
以下の例はJSON形式エラーレスポンスのサンプルです。
https://www.j-shis.bosai.go.jp/map/api/sstrct/V10/phys.json
{ "status": "Error", "error": { "code": "INVALID_REQUEST", "message": "Supported options for [version] are : V1 / V2 / V3/ V4" } }
XML形式
XML形式のリクエストでエラーが発生した場合のレスポンスは以下の通りです。
タグ | 説明 | |
---|---|---|
jshis:status | ステータス
|
|
jshis:error | エラー情報 | |
jshis:code | エラー分類コード | |
jshis:message | エラー内容を示すメッセージ |
以下の例はXML形式エラーレスポンスのサンプルです。
https://www.j-shis.bosai.go.jp/map/api/sstrct/V10/phys.xml
<?xml version="1.0" encoding="utf-8"?> <jshis:SstrctPhys 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/sstrct-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/ V4</jshis:message> </jshis:error> </jshis:SstrctPhys>