Damaging Fault Search API for municipality
Version
Request URL
Table of contents
Request
– URL
– Parameters
Response
– Status code
– Normal case
– JSON format
– XML format
– Error case
– Error classification code
– JSON format
– XML format
Request
URL
In the URL, bold characters indicate a request parameter; superscript number corresponds to the No. in parameter list.
Parameters
Request parameters of the API are as follows. The parameters are case-sensitive.
No | Parameter | Dispensability | Input value and Description |
---|---|---|---|
1 | areacode | Required | Five digits with prefix “A” are composed of double digits of prefectural code (JISX0401) and three digits of municipal code as examples given.
|
2 | ecode | Required | Population type code
|
3 | mode | Required | Scenario earthquake code
|
4 | version | Required | Map version
|
5 | case | Required | Probability case
|
6 | period | Required | Evaluated period of a probability of occurrence
|
7 | format | Required | Response format
|
8 | param | Optional | Evaluated parameter (Priority to catastrophic hazard)
Default value…0.6 Note1) A generalized risk index RG(α;Y,I) is defined as follows. (Noshima, et al., 2010)
Note2) Examples of a catastrophe priority are given as follows.
|
8 | ijma | Optional | Threshold IJMA of probability of exceedance
Default value…55 |
8 | lang | Optional | Response language
Note) A default value is “ja”. |
Response
Status code
The data acquisition is successful, once you got the return HTTP 200 status code. Otherwise, please see the following HTTP status code.
HTTP status code | Description | Detail |
---|---|---|
400 | Bad Request | The request could not be understood by the server due to malformed syntax.
For example, unsupported value was setup. |
403 | Forbidden | The server understood the request, but is refusing to fulfill it.
For example, requests exceeded the upper limits of normal. |
404 | Not Found | The server has not found anything matching the Request-URI.
For example, non-existent mesh code was specified. |
500 | Internal Server Error | The server encountered an unexpected condition which prevented it from fulfilling the request. |
503 | Service Unavailable | The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.
For example, a database connection fails. |
Normal case
JSON format
JSON response is as follows.
Tag | Description | |
---|---|---|
status | Request status
|
|
Fault | Member element of a fault list
|
|
rank | Fault ranking This number is ranked from the largest score obtained with the evaluation function to the smallest one. |
|
ltecode | Fault code Refer to The J-SHIS Fault Code for details. |
|
ltecase | Fault case name This value exists only if a mode equals “S”. |
|
ltename | Fault name | |
eqcode | Earthquake code
Refer to The J-SHIS Earthquake Code for details. |
|
eqgroup | Earthquake group
|
|
eqcategory | Earthquake category <2008 to 2019 version>
<2020 version ~ >
|
|
case | Average/Maximum case
|
|
probability | Probability of occurrence | |
magnitude | Magnitude Note) Negative value of magnitude means moment magnitude and positive means JMA magnitude. If the magnitude has a range, comma-separated list of minimum and maximum values is written. e.g. Magnitude range from 6.0 to 6.5…”6.0,6.5″ |
|
score | Value of evaluation function This value only has relative meaning. The more influence, the larger value. |
|
pex | Population exposure to seismic intensity For earthquakes that consider occurrence patterns, this is the weighted average value calculated from the values of occurrence pattern list member and weight values assigned to the each patterns. |
|
Pattern | Member element of an occurrence pattern list This tag exists for only earthquakes that consider occurrence patterns. Refer to occurrence pattern attribute table for detail of each element. |
|
metaData | Meta-information
|
|
areacode | Five digits with prefix “A” are composed of double digits of prefectural code (JISX0401) and three digits of municipal code as examples given.
|
|
ecode | Population type code | |
mode | Scenario earthquake code included in a response | |
version | Map version | |
case | Probability case | |
period | Evaluated period of a probability of occurrence | |
param | Evaluated a parameter | |
ijma | Threshold IJMA of probability of exceedance | |
lang | Language |
{ "Fault": [ { "case": "MAX", "eqcategory": "3", "eqcode": "LND_A98F", "eqgroup": "A", "ltecase": "1", "ltecode": "F01482B", "ltename": "Fukaya/Ayasegawa fault zone (Kounosu-Ina segment/Ina-Kawaguchi segment)", "magnitude": "-7", "pex": "8145", "probability": "0.00000000", "rank": "3", "score": "0.000e+00" }, { "case": "MAX", "eqcategory": "3", "eqcode": "LND_A98F", "eqgroup": "A", "ltecase": "1", "ltecode": "F01482C", "ltename": "Fukaya/Ayasegawa fault zone (All segment)", "magnitude": "-7.5", "pex": "59805", "probability": "0.00000000", "rank": "2", "score": "0.000e+00" }, { "case": "MAX", "eqcategory": "4", "eqcode": "PLE_ASGMI", "eqgroup": "C", "ltecase": "1", "ltecode": "ASGMI", "ltename": "Sagami Trough earthquakes (M8 class)", "magnitude": "-7.9,-8.6", "Pattern": [ { "case": "MAX", "eqcategory": "4", "eqcode": "PLE_ASGMI", "eqgroup": "C", "ltecase": "1", "ltecode": "ASG01", "ltename": "Sagami Trough earthquakes (M8 class: Area1)", "magnitude": "-7.9", "pex": "3406", "probability": "0.02097600", "rank": "7", "score": "9.558e+04" }, { "case": "MAX", "eqcategory": "4", "eqcode": "PLE_ASGMI", "eqgroup": "C", "ltecase": "1", "ltecode": "ASG03", "ltename": "Sagami Trough earthquakes (M8 class: Area3)", "magnitude": "-8", "pex": "13529", "probability": "0.01704300", "rank": "6", "score": "7.992e+05" }, { "case": "MAX", "eqcategory": "4", "eqcode": "PLE_ASGMI", "eqgroup": "C", "ltecase": "1", "ltecode": "ASG04", "ltename": "Sagami Trough earthquakes (M8 class: Area4)", "magnitude": "-8.3", "pex": "1257", "probability": "0.00279300", "rank": "8", "score": "8.665e+03" }, { "case": "MAX", "eqcategory": "4", "eqcode": "PLE_ASGMI", "eqgroup": "C", "ltecase": "1", "ltecode": "ASG05", "ltename": "Sagami Trough earthquakes (M8 class: Area5)", "magnitude": "-8.4", "pex": "58872", "probability": "0.00159600", "rank": "1", "score": "3.259e+06" }, { "case": "MAX", "eqcategory": "4", "eqcode": "PLE_ASGMI", "eqgroup": "C", "ltecase": "1", "ltecode": "ASG06", "ltename": "Sagami Trough earthquakes (M8 class: Area6)", "magnitude": "-8.5", "pex": "58872", "probability": "0.00062700", "rank": "4", "score": "2.243e+06" }, { "case": "MAX", "eqcategory": "4", "eqcode": "PLE_ASGMI", "eqgroup": "C", "ltecase": "1", "ltecode": "ASG07", "ltename": "Sagami Trough earthquakes (M8 class: Area7)", "magnitude": "-8.5", "pex": "59805", "probability": "0.00062700", "rank": "3", "score": "2.300e+06" }, { "case": "MAX", "eqcategory": "4", "eqcode": "PLE_ASGMI", "eqgroup": "C", "ltecase": "1", "ltecode": "ASG08", "ltename": "Sagami Trough earthquakes (M8 class: Area8)", "magnitude": "-8.6", "pex": "59805", "probability": "0.00102600", "rank": "2", "score": "2.801e+06" }, { "case": "MAX", "eqcategory": "4", "eqcode": "PLE_ASGMI", "eqgroup": "C", "ltecase": "1", "ltecode": "ASG10", "ltename": "Sagami Trough earthquakes (M8 class: Area10)", "magnitude": "-8.2", "pex": "35889", "probability": "0.00239400", "rank": "5", "score": "1.736e+06" } ], "pex": "13193", "probability": "0.05700000", "rank": "1", "score": "1.244e+06" } ], "metaData": { "areacode": "A13101", "case": "MAX", "ecode": "ALL_NT_A", "ijma": "60", "lang": "en", "mode": "C", "param": "0.6", "period": "P_T30", "version": "Y2020" }, "status": "Success" }
XML format
XML response is given as following.
Tag | Description | ||
---|---|---|---|
jshis: status |
Request status
|
||
jshis: Faults |
Faults array element of information | ||
jshis: Fault |
Fault member element | ||
rank | Fault ranking This number is ranked from the largest score obtained with the evaluation function to the smallest one. |
||
ltecode | Fault code
Refer to The J-SHIS Fault Code for details. |
||
ltecase | Fault case name This value exists only if a mode equals “S”. |
||
ltename | Fault name | ||
eqcode | Earthquake code
Refer to The J-SHIS Earthquake Code for details. |
||
eqgroup | Earthquake group
|
||
eqcategory | Earthquake category <2008 to 2019 version>
<2020 version ~ >
|
||
case | Average/Maximum case
|
||
probability | Probability of occurrence | ||
magnitude | Magnitude Note) Negative value of magnitude means moment magnitude and positive means JMA magnitude. If the magnitude has a range, comma-separated list of minimum and maximum values is written. e.g. Magnitude range from 6.0 to 6.5…”6.0,6.5″ |
||
score | Value of evaluation function This value only has relative meaning. The more influence, the larger value. |
||
pex | Population exposure to seismic intensity | ||
jshis:Patterns | Member element of an occurrence pattern list This tag exists for only earthquakes that consider occurrence patterns. Refer to occurrence pattern attribute table for detail of each element; jshis:Pattern. |
||
jshis:metaData | Meta-information | ||
jshis:areacode |
Five digits with prefix “A” are composed of double digits of prefectural code (JISX0401) and three digits of municipal code as examples given.
|
||
jshis:ecode | Population type code | ||
jshis:mode | Scenario earthquake code included in a response | ||
jshis: version |
Map version | ||
jshis: case |
Probability case | ||
jshis: period |
Evaluated period of a probability of occurrence | ||
jshis: param |
Evaluated a parameter | ||
jshis: ijma |
Threshold IJMA of probability of exceedance | ||
jshis: lang |
Language |
<?xml version="1.0" encoding="utf-8"?> <jshis:FltsearchArea 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/fltsearch-area-v1.1.xsd"> <jshis:status>Success</jshis:status> <jshis:metaData> <jshis:areacode>A08220</jshis:areacode> <jshis:case>AVR</jshis:case> <jshis:ecode>ALL_NT_A</jshis:ecode> <jshis:ijma>60</jshis:ijma> <jshis:lang>en</jshis:lang> <jshis:mode>C</jshis:mode> <jshis:param>0.6</jshis:param> <jshis:period>P_T30</jshis:period> <jshis:version>Y2020</jshis:version> </jshis:metaData> <jshis:Faults> <jshis:Fault case="AVR" eqcategory="4" eqcode="PLE_ASGMI" eqgroup="C" ltecase="1" ltecode="ASGMI" ltename="Sagami Trough earthquakes (M8 class)" magnitude="-7.9,-8.6" pex="4677" probability="0.00800000" rank="1" score="1.080e+05"> <jshis:Patterns> <jshis:Pattern case="AVR" eqcategory="4" eqcode="PLE_ASGMI" eqgroup="C" ltecase="1" ltecode="ASG08" ltename="Sagami Trough earthquakes (M8 class: Area8)" magnitude="-8.6" pex="134935" probability="0.00014400" rank="1" score="4.694e+06"/> <jshis:Pattern case="AVR" eqcategory="4" eqcode="PLE_ASGMI" eqgroup="C" ltecase="1" ltecode="ASG07" ltename="Sagami Trough earthquakes (M8 class: Area7)" magnitude="-8.5" pex="134935" probability="0.00008800" rank="2" score="3.855e+06"/> <jshis:Pattern case="AVR" eqcategory="4" eqcode="PLE_ASGMI" eqgroup="C" ltecase="1" ltecode="ASG04" ltename="Sagami Trough earthquakes (M8 class: Area4)" magnitude="-8.3" pex="5345" probability="0.00039200" rank="3" score="4.000e+04"/> <jshis:Pattern case="AVR" eqcategory="4" eqcode="PLE_ASGMI" eqgroup="C" ltecase="1" ltecode="ASG05" ltename="Sagami Trough earthquakes (M8 class: Area5)" magnitude="-8.4" pex="5677" probability="0.00022400" rank="4" score="3.522e+04"/> <jshis:Pattern case="AVR" eqcategory="4" eqcode="PLE_ASGMI" eqgroup="C" ltecase="1" ltecode="ASG06" ltename="Sagami Trough earthquakes (M8 class: Area6)" magnitude="-8.5" pex="5677" probability="0.00008800" rank="5" score="2.424e+04"/> <jshis:Pattern case="AVR" eqcategory="4" eqcode="PLE_ASGMI" eqgroup="C" ltecase="1" ltecode="ASG02" ltename="Sagami Trough earthquakes (M8 class: Area2)" magnitude="-8.2" pex="2117" probability="0.00048000" rank="6" score="9.860e+03"/> <jshis:Pattern case="AVR" eqcategory="4" eqcode="PLE_ASGMI" eqgroup="C" ltecase="1" ltecode="ASG10" ltename="Sagami Trough earthquakes (M8 class: Area10)" magnitude="-8.2" pex="715" probability="0.00033600" rank="7" score="1.507e+03"/> <jshis:Pattern case="AVR" eqcategory="4" eqcode="PLE_ASGMI" eqgroup="C" ltecase="1" ltecode="ASG03" ltename="Sagami Trough earthquakes (M8 class: Area3)" magnitude="-8" pex="225" probability="0.00239200" rank="8" score="5.210e+02"/> <jshis:Pattern case="AVR" eqcategory="4" eqcode="PLE_ASGMI" eqgroup="C" ltecase="1" ltecode="ASG01" ltename="Sagami Trough earthquakes (M8 class: Area1)" magnitude="-7.9" pex="135" probability="0.00294400" rank="9" score="2.506e+02"/> <jshis:Pattern case="AVR" eqcategory="4" eqcode="PLE_ASGMI" eqgroup="C" ltecase="1" ltecode="ASG09" ltename="Sagami Trough earthquakes (M8 class: Area9)" magnitude="-7.9" pex="18" probability="0.00090400" rank="10" score="6.609e+00"/> </jshis:Patterns> </jshis:Fault> <jshis:Fault case="AVR" eqcategory="3" eqcode="LND_A98F" eqgroup="A" ltecase="1" ltecode="F01482C" ltename="Fukaya/Ayasegawa fault zone (All segment)" magnitude="-7.5" pex="379" probability="0.00000000" rank="2" score="0.000e+00"/> <jshis:Fault case="AVR" eqcategory="4" eqcode="PLE_AJTHK" eqgroup="C" ltecase="1" ltecode="AJTHK" ltename="Mega earthquakes along the Japan Trench (Great East Japan Earthquake 2011 type)" magnitude="-8.6,-9" pex="35" probability="0.00000000" rank="3" score="0.000e+00"> <jshis:Patterns> <jshis:Pattern case="AVR" eqcategory="4" eqcode="PLE_AJTHK" eqgroup="C" ltecase="1" ltecode="AJT06" ltename="Mega earthquakes along the Japan Trench (Great East Japan Earthquake 2011 type) (Mw9.0 model1)" magnitude="-9" pex="35" probability="0.00000000" rank="1" score="0.000e+00"/> <jshis:Pattern case="AVR" eqcategory="4" eqcode="PLE_AJTHK" eqgroup="C" ltecase="1" ltecode="AJT10" ltename="Mega earthquakes along the Japan Trench (Great East Japan Earthquake 2011 type) (Mw8.9 model2)" magnitude="-8.9" pex="35" probability="0.00000000" rank="2" score="0.000e+00"/> <jshis:Pattern case="AVR" eqcategory="4" eqcode="PLE_AJTHK" eqgroup="C" ltecase="1" ltecode="AJT05" ltename="Mega earthquakes along the Japan Trench (Great East Japan Earthquake 2011 type) (Mw8.8 model2)" magnitude="-8.8" pex="35" probability="0.00000000" rank="3" score="0.000e+00"/> <jshis:Pattern case="AVR" eqcategory="4" eqcode="PLE_AJTHK" eqgroup="C" ltecase="1" ltecode="AJT09" ltename="Mega earthquakes along the Japan Trench (Great East Japan Earthquake 2011 type) (Mw8.7 model3)" magnitude="-8.7" pex="35" probability="0.00000000" rank="4" score="0.000e+00"/> </jshis:Patterns> </jshis:Fault> </jshis:Faults> </jshis:FltsearchArea>
The contents of each element of the occurrence pattern list are shown below.
Attribute | Description |
---|---|
rank | Pattern ranking This number is ranked within the occurrence pattern from the largest score to the smallest one obtained with the evaluation function. |
ltecode | Fault code
Refer to The J-SHIS Fault Code for details. |
ltecase | Fault case name This value exists only if a mode equals “S”. |
ltename | Fault name |
eqcode | Earthquake code
Refer to The J-SHIS Earthquake Code for details. |
eqgroup | Earthquake group
|
eqcategory | Earthquake category <2008 to 2019 version>
<2020 version ~ >
|
case | Average / Maximum case
|
probability | Probability of occurrence Probability for earthquakes that consider occurrence pattern multiplied weight value assigned to the each patterns. |
magnitude | Magnitude Note) Negative value of magnitude means moment magnitude and positive means JMA magnitude. If the magnitude has a range, comma-separated list of minimum and maximum values is written. e.g. Magnitude range from 6.0 to 6.5…”6.0,6.5″ |
score |
Value of evaluation function This value only has relative meaning. The more influence, the larger value. |
pex | Population exposure to seismic intensity |
Error case
Error classification code
Error classification code is given as following.
Classification code | Description |
---|---|
INVALID_REQUEST | The request could not be understood by the server due to malformed syntax. |
DB_CONNECT_ERROR | An error about Database occurred while processing your request. |
UNKNOWN_ERROR | An unknown error occurred while processing your request. |
NOT_FOUND | The server has not found anything matching the Request-URI. |
JSON format
Once a request failed, response in JSON format is given as following.
Tag | Description | |
---|---|---|
type | The type of the JSON object
|
|
status | Status
|
|
error | Error information | |
code | An error classification code | |
message | An error message |
{ "status": "Error", "error": { "code": "INVALID_REQUEST", "message": "Supported formats are json,xml" } }
XML format
In a request failed, response in XML format is as follows.
Tag | Description | |
---|---|---|
jshis:status | Request status
|
|
jshis:error | Error information | |
jshis:code | An error classification code | |
jshis:message | An error message |
<?xml version="1.0" encoding="utf-8"?> <jshis:FltsearchArea 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/fltsearch-area-v1.0.xsd"> <jshis:status>Error</jshis:status> <jshis:error> <jshis:code>INVALID_REQUEST</jshis:code> <jshis:message>Supported options for [period] are : P_T30 / P_T50 </jshis:message> </jshis:error> </jshis:FltsearchArea>