Deep subsurface structural information API
Version
Request URL
Table of contents
Request
– URL
– By Mesh code
– By Longitude and Latitude
– Parameters
Response
– Status code
– Normal case
– GeoJSON format
– GML format
– Error case
– Error classification code
– GeoJSON format
– GML format
Request
URL
There are two ways that you can specify search position, either by longitude and latitude or by the mesh code. In the URL, bold characters indicate a request parameter; superscript number corresponds to the No. in parameter list.
By Mesh code
By Longitude and Latitude
Parameters
Request parameters of the API are as follows. The parameters are case-sensitive.
No | Parameter | Dispensability | Input values and Description |
---|---|---|---|
1 | version | Required | Version code
Refer to a list of version codes for details. |
2 | attr | Required | attribute type
|
3 | format | Required | Response format
|
4 | meshcode | Conditional |
Mesh code
Refer to the Basic Grid Square Code definition for details. Note) Request fails if the “epsg” or “position” parameter is specified with this parameter. |
5 | position | Conditional | Longitude and Latitude are separated by a comma. The coordinates are restricted in the following regions.
Note1) This parameter is required when “epsg” parameter is specified. |
8 | epsg | Conditional | EPSG code
Note1) This parameter is required when “position” parameter is specified. |
The following is a list of version code.
Version code | Description |
---|---|
V1 | Fujiwara, H. et al. (2009), “A Study on Subsurface Structure Model for Deep Sedimentary Layers of Japan for Strong-motion Evaluation”, Technical Note of the National Research Institute for Earth Science and Disaster Prevention, No. 337, Page 4-11 – 4-24, in Japanese |
V2 | Fujiwara, H. et al. (2012), “Some Improvements of Seismic Hazard Assessment based on the 2011 Tohoku Earthquake”, Technical Note of the National Research Institute for Earth Science and Disaster Prevention, No. 379, in Japanese |
V3.2 | The Headquarters for Earthquake Research Promotion (2021), “Modeling concept of subsurface structures from seismic bedrock to ground surface” (in Japanese) |
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
GeoJSON format
GeoJSON response is as follows.
Tag | Description | ||
---|---|---|---|
type | The type of the GeoJSON object
|
||
crs | The coordinate reference system (CRS) of the GeoJSON object | ||
status | Request status
|
||
features | Member element An array with a geometry of the rectangular mesh and its attribute |
||
type | The type of the GeoJSON object
|
||
geometry | A geometry object of the rectangular mesh | ||
properties | Any JSON object or a JSON null object | ||
meshcode |
Mesh code
Refer to the Basic Grid Square Code definition for details. |
||
tn0 | Deep subsurface structural attribute
|
||
tn1 | Depth or elevation of the lower surface at layer No. 1 | ||
tn2 | Depth or elevation of the lower surface at layer No. 2 | ||
・・ | ・・・ | ||
tnN | Depth or elevation of the lower surface at layer No. N | ||
metaData | Meta-information | ||
meshcode |
Mesh code
Refer to the Basic Grid Square Code definition for details. |
||
version | Version code | ||
attr | Attribute | ||
name | Attribute type
|
||
unit | Unit of the attribute value |
{ "type": "FeatureCollection", "crs": { "type": "name", "properties": { "name": "urn:ogc:def:crs:EPSG:4301" } }, "status": "Success", "features": [ { "type": "Feature", "geometry": { "coordinates": [ [ [ 140.0875, 36.116667 ], [ 140.0875, 36.11875 ], [ 140.090625, 36.11875 ], [ 140.090625, 36.116667 ], [ 140.0875, 36.116667 ] ] ], "type":"Polygon" }, "properties": { "meshcode":"54401047N", "tn0" :"0" , "tn1" :"0" , "tn2" :"0" , "tn3" :"0" , "tn4" :"264", "tn5" :"264", "tn6" :"264", "tn7" :"264", "tn8" :"264", "tn9" :"264", "tn10":"264", "tn11":"264", "tn12":"400", "tn13":"400", "tn14":"400", "tn15":"400", "tn16":"400", "tn17":"400", "tn18":"400", "tn19":"535", "tn20":"535", "tn21":"535", "tn22":"535", "tn23":"535", "tn24":"535", "tn25":"535", "tn26":"535", "tn27":"670", "tn28":"670", "tn29":"670", "tn30":"670", "tn31":"2158","tn32":"7158" } } ], "metaData": { "meshcode": "54401047N", "version": "V1", "attr": [ { "name": "LYRD", "unit": "m" } ] } }
GML format
GML response is given as following.
Tag | Description | |||
---|---|---|---|---|
gml: boundedBy |
A bounding box of all geometries included in the response | |||
gml: featureMember |
Member element | |||
jshis: mesh |
Mesh | |||
gml: coverage |
A geometry object of the rectangular mesh | |||
jshis: meshcode |
Mesh code
Refer to the Basic Grid Square Code definition for details. |
|||
jshis: tn0 |
Deep subsurface structural attribute
|
|||
jshis: tn1 |
Depth or elevation of the lower surface at layer No. 1 | |||
jshis: tn2 |
Depth or elevation of the lower surface at layer No. 2 | |||
・・・ | ・・・ | |||
jshis: tnN |
Depth or elevation of the lower surface at layer No. N | jshis: status |
Request status
|
|
jshis: metaData |
Meta-information | |||
jshis: meshcode |
Mesh code
Refer to the Basic Grid Square Code definition for details. |
|||
jshis: version |
Version code | |||
jshis: attrs |
Attribute array | |||
jshis: attr |
Attribute | |||
jshis: name |
Attribute type
|
|||
jshis: unit |
unit |
<?xml version="1.0" encoding="utf-8" ?> <jshis:DstrctMeshinfo xmlns:gml="http://www.opengis.net/gml" 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-meshinfo-v1.0.xsd"> <gml:boundedBy> <gml:Box srsName="urn:ogc:def:crs:EPSG:4301"> <gml:coord><gml:X>140.0890625</gml:X><gml:Y>36.117708</gml:Y></gml:coord> <gml:coord><gml:X>140.0953125</gml:X><gml:Y>36.121875</gml:Y></gml:coord> </gml:Box> </gml:boundedBy> <gml:featureMember> <jshis:mesh> <gml:coverage> <gml:Polygon srsName="urn:ogc:def:crs:EPSG:4301"> <gml:outerBoundaryIs> <gml:LinearRing> <gml:coordinates> 140.0875,36.116667 140.0875,36.11875 140.090625,36.11875 140.090625,36.116667 140.0875,36.116667 </gml:coordinates> </gml:LinearRing> </gml:outerBoundaryIs> </gml:Polygon> </gml:coverage> <jshis:meshcode>54401047N</jshis:meshcode> <jshis:tn0>0</jshis:tn0><jshis:tn1>0</jshis:tn1><jshis:tn2>0</jshis:tn2> <jshis:tn3>0</jshis:tn3><jshis:tn4>264</jshis:tn4><jshis:tn5>264</jshis:tn5> <jshis:tn6>264</jshis:tn6><jshis:tn7>264</jshis:tn7><jshis:tn8>264</jshis:tn8> <jshis:tn9>264</jshis:tn9><jshis:tn10>264</jshis:tn10> <jshis:tn11>264</jshis:tn11><jshis:tn12>400</jshis:tn12> <jshis:tn13>400</jshis:tn13><jshis:tn14>400</jshis:tn14> <jshis:tn15>400</jshis:tn15><jshis:tn16>400</jshis:tn16> <jshis:tn17>400</jshis:tn17><jshis:tn18>400</jshis:tn18> <jshis:tn19>535</jshis:tn19><jshis:tn20>535</jshis:tn20> <jshis:tn21>535</jshis:tn21><jshis:tn22>535</jshis:tn22> <jshis:tn23>535</jshis:tn23><jshis:tn24>535</jshis:tn24> <jshis:tn25>535</jshis:tn25><jshis:tn26>670</jshis:tn26> <jshis:tn27>670</jshis:tn27><jshis:tn28>670</jshis:tn28> <jshis:tn29>670</jshis:tn29><jshis:tn30>670</jshis:tn30> <jshis:tn31>2158</jshis:tn31><jshis:tn32>7158</jshis:tn32> </jshis:mesh> </gml:featureMember> <jshis:status>Success</jshis:status> <jshis:metaData> <jshis:meshcode>54401047N</jshis:meshcode> <jshis:version>V1</jshis:version> <jshis:attrs> <jshis:attr> <jshis:name>LYRD</jshis:name> <jshis:unit>m</jshis:unit> </jshis:attr> </jshis:attrs> </jshis:metaData> </jshis:DstrctMeshinfo>
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. |
GeoJSON format
Once a request failed, response in GeoJSON format is given as following.
Tag | Description | |
---|---|---|
type | The type of the GeoJSON object
|
|
status | Request status
|
|
error | Error information | |
code | The error classification code | |
message | An error message | |
features | An empty array |
{ "type": "FeatureCollection", "status": "Error", "error": { "code": "INVALID_REQUEST", "message": "Supported formats are geojson, gml" }, "features": [ { "geometry": { "coordinates": [ [] ] } } ] }
GML format
In a request failed, response in GML format is as follows.
Tag | Description | |
---|---|---|
gml:boundedBy | null element
<gml:null>unknown</gml:null> (fixed) |
|
gml:featureMember | An empty array | |
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:DstrctMeshinfo xmlns:gml="http://www.opengis.net/gml" 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-meshinfo-v1.0.xsd"> <gml:boundedBy> <gml:null>unknown</gml:null> </gml:boundedBy> <gml:featureMember/> <jshis:status>Error</jshis:status> <jshis:error> <jshis:code>INVALID_REQUEST</jshis:code> <jshis:message>Supported options for [attr] are : LYRD / LYRE </jshis:message> </jshis:error> </jshis:DstrctMeshinfo>