Shallow structure mesh information API

TOP > API > Shallow structure mesh information API

その他

Shallow structure mesh information API

This API provides attribute information for shallow subsurface.

Version

1.0.0

Request URL

https://www.j-shis.bosai.go.jp/map/api/sstrct/version/meshinfo.format?meshcode=meshcode&options

https://www.j-shis.bosai.go.jp/map/api/meshcode/sstrct/version/meshinfo.format?options

https://www.j-shis.bosai.go.jp/map/api/sstrct/version/meshinfo.format?position=position&epsg=epsg&options

Response

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

https://www.j-shis.bosai.go.jp/map/api/sstrct/version¹/meshinfo.format²?meshcode=meshcode³&options⁶

https://www.j-shis.bosai.go.jp/map/api/meshcode³/sstrct/version¹/meshinfo.format²?options⁶

By Longitude and Latitude

https://www.j-shis.bosai.go.jp/map/api/sstrct/version¹/meshinfo.format²?position=position⁴&epsg=epsg⁵&options⁶

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 Version 1…V1 Version 2…V2 Version 3…V3 Version 4…V4 Refer to a list of version codes for details.
2	format	Required	format GeoJSON format…geojson GML format…gml
3	meshcode	Conditional	250m mesh code Refer to the Quarter Grid Square definition for more information. Note) Request fails if the “epsg” or “position” parameter is specified with this parameter.
4	position	Conditional	Longitude and Latitude are separated by a comma. The coordinates are restricted in the following regions. 122.0≦Longitude≦154.0 20.0≦Latitude≦47.0 Note1) This parameter is required when “epsg” parameter is specified. Note2) Request fails if a “meshcode” parameter is specified.
5	epsg	Conditional	EPSG code JGD2000…4612 Tokyo…4301 WGS84…4326 Note1) This parameter is required when “position” parameter is specified. Note2) Request fails if a “meshcode” parameter is specified.
6	attr	Optional	shallow subsurface attribute code Refer to a list of shallow subsurface attribute codes for details. If not specified, all attribute are returned.
6	lang	Optional	Response language Japanese…ja English…en Note) A default value is “ja”.

The following is a list of version codes.

Version code	Description
V1	The 250m mesh data converted by dividing a third-mesh (about 1km square) into 16 meshes used for from 2005 version to 2008 version of “Probabilistic Seismic Hazard Maps”.
V2	The 250m mesh data used for 2009 version of “National Seismic Hazard Maps for Japan”.
V3	The 250m mesh data used for 2014 version of “National Seismic Hazard Maps for Japan”.
V4	The 250m mesh data used for 2020 version of “National Seismic Hazard Maps for Japan”.

The following is a attribute code list for shallow subsurface.

Factor name	Format	Description
JCODE	%2d	Classification code for engineering geomorphologic Note that the code varies depending on the version code. Refer to Guide for file “Site amplification factors” for details.
JNAME	%s	Classification name for engineering geomorphologic Refer to Guide for file “Site amplification factors” for details.
AVS	%5.1f	Average S-wave velocity in the upper 30m of the ground
ARV	%9.4f	Site amplification factor (Vs=400m/s – surface)
AVS_EB	%5.1f	Average S-wave velocity in the 30m depth from engineering bedrock in the detailed method ‘-‘ means an undefined value. Note) This exists only for version 4.
AVS_REF	%d	Classification number of references of average S-wave velocity in the upper 30m of the ground AVS_REF = 0 Wakamatsu, K. and Matsuoka, M. (20 20): “Update of the Nationwide 7.5-Arc -Second Japan Engineering Geomorphologic Classification Map and Vs30 Zoning”, Bulletin of JAEE, No.40, pp.24-27 (in Japanese) AVS_REF = 1 Senna et al. (2013) (DOI) and Senna et al. (2019) (DOI) Note) This exists only for version 4.

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 FeatureCollection (fixed)
crs			The coordinate reference system (CRS) of the GeoJSON object
status			Request status Success (fixed)
features			Member element An array with a geometry of the rectangular mesh and its attribute
	type		The type of the GeoJSON object Feature (fixed)
	geometry		A geometry object of the rectangular mesh
	properties		Any JSON object or a JSON null object
		meshcode	250m mesh code Refer to the Quarter Grid Square definition for details.
		JCODE	Classification code for engineering geomorphologic Refer to a list of shallow subsurface attribute codes for details.
		JNAME	Classification name for engineering geomorphologic Refer to a list of shallow subsurface attribute codes for details.
		AVS	Average S-wave velocity in the upper 30m of the ground Refer to a list of shallow subsurface attribute codes for details.
		ARV	Site amplification factor (Vs=400m/s – surface) Refer to a list of shallow subsurface attribute codes for details.
metaData			Meta-information
	meshcode		250m mesh code Refer to the Quarter Grid Square definition for more information.
	version		Version code
	attr		shallow subsurface attribute
		name	shallow subsurface attribute code Refer to a list of shallow subsurface attribute codes for details.
		unit	Unit of the attribute value

Response sample

Request URL

https://www.j-shis.bosai.go.jp/map/api/
sstrct/V2/meshinfo.geojson?position=139.7486814,35.65531022&epsg=4301&lang=en

GeoJSON format response

{
  "type":"FeatureCollection",
   "crs":{
      "type":"name",
      "properties":{
         "name":"urn:ogc:def:crs:EPSG:4301"
      }
   },
   "status":"Success",
   "features":[
      {
         "geometry":{
            "coordinates":[
               [
                  [
                     139.74687,
                     35.65417
                  ],
                  [
                     139.74687,
                     35.65625
                  ],
                  [
                     139.75,
                     35.65625
                  ],
                  [
                     139.75,
                     35.65417
                  ],
                  [
                     139.74687,
                     35.65417
                  ]
               ]
            ],
            "type":"Polygon"
         },
         "type":"Feature",
         "properties":{
            "JNAME":"Terrace covered with volcanic ashsoil",
            "AVS":"246.9",
            "ARV":"1.5083",
            "JCODE":"9",
            "meshcode":"5339358942N"
         }
      }
   ],
   "metaData":{
      "version":"V2",
      "attr":[
         {
            "unit":"",
            "name":"JNAME"
         },
         {
            "unit":"",
            "name":"JCODE"
         },
         {
            "unit":"m/s",
            "name":"AVS"
         },
         {
            "unit":"",
            "name":"ARV"
         }
      ],
      "meshcode":"5339358942N"
   }
}

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		250m mesh code Refer to the Quarter Grid Square definition for details.
		jshis: JCODE		Classification code for engineering geomorphologic Refer to a list of shallow subsurface attribute codes for details.
		jshis: JNAME		Classification name for engineering geomorphologic Refer to a list of shallow subsurface attribute codes for details.
		jshis: AVS		Average S-wave velocity in the upper 30m of the ground Refer to a list of shallow subsurface attribute codes for details.
		jshis: ARV		Site amplification factor (Vs=400m/s – surface) Refer to a list of shallow subsurface attribute codes for details.
jshis: status				Request status Success (fixed)
jshis: metaData				Meta-information
	jshis: meshcode			250m mesh code Refer to the Quarter Grid Square definition for more information.
	jshis: version			Version code
	jshis: attrs			shallow subsurface attribute array
		jshis: attr		shallow subsurface attribute
			jshis: name	shallow subsurface attribute code Refer to a list of shallow subsurface attribute codes for details.
			jshis: unit	Unit of the attribute value

Response sample

Request URL

https://www.j-shis.bosai.go.jp/map/api/5339358942N/sstrct/V1/meshinfo.gml&lang=en

GML format response

<?xml version="1.0" encoding="utf-8"?>
<jshis:SstrctMeshinfo 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/sstrct-meshinfo-v1.0.xsd">
    <gml:boundedBy>
        <gml:Box srsName="urn:ogc:def:crs:EPSG:4301">
            <gml:coord>
                <gml:X>139.74687</gml:X>
                <gml:Y>35.65417</gml:Y>
            </gml:coord>
            <gml:coord>
                <gml:X>139.75</gml:X>
                <gml:Y>35.65625</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>139.74687,35.65417 139.74687,35.65625 139.75,35.65625 139.75,35.65417 139.74687,35.65417 </gml:coordinates>
                        </gml:LinearRing>
                    </gml:outerBoundaryIs>
                </gml:Polygon>
            </gml:coverage>
            <jshis:meshcode>5339358942N</jshis:meshcode>
            <jshis:JNAME>Valley plain</jshis:JNAME>
            <jshis:JCODE>13</jshis:JCODE>
            <jshis:AVS>205.0</jshis:AVS>
            <jshis:ARV>1.5371</jshis:ARV>
        </jshis:mesh>
    </gml:featureMember>
    <jshis:status>Success</jshis:status>
    <jshis:metaData>
        <jshis:attrs>
            <jshis:attr>
                <jshis:name>JNAME</jshis:name>
                <jshis:unit/>
            </jshis:attr>
            <jshis:attr>
                <jshis:name>JCODE</jshis:name>
                <jshis:unit/>
            </jshis:attr>
            <jshis:attr>
                <jshis:name>AVS</jshis:name>
                <jshis:unit>m/s</jshis:unit>
            </jshis:attr>
            <jshis:attr>
                <jshis:name>ARV</jshis:name>
                <jshis:unit/>
            </jshis:attr>
        </jshis:attrs>
        <jshis:meshcode>5339358942N</jshis:meshcode>
        <jshis:version>V1</jshis:version>
    </jshis:metaData>
</jshis:SstrctMeshinfo>

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 FeatureCollection (fixed)
status		Request status Error (fixed)
error		Error information
	code	The error classification code
	message	An error message
features		An empty array

Response sample

Request URL

https://www.j-shis.bosai.go.jp/map/api/6034744542N/sstrct/V2/meshinfo.geojson

GeoJSON format error response

{
    "type": "FeatureCollection",
    "status": "Error",
    "error": {
        "code": "NOT_FOUND",
        "message": "No data is found for the query"
    },
    "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 Error (fixed)
jshis:error		Error information
	jshis:code	An error classification code
	jshis:message	An error message

Response sample

Request URL

https://www.j-shis.bosai.go.jp/map/api/6034744542N/sstrct/V2/meshinfo.gml

GML format error response

<?xml version="1.0" encoding="utf-8"?>
<jshis:SstrctMeshinfo 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/sstrct-meshinfo-v1.0.xsd">
    <gml:boundedBy>
        <gml:null>unknown</gml:null>
    </gml:boundedBy>
    <gml:featureMember/>
    <jshis:status>Error</jshis:status>
    <jshis:error>
        <jshis:code>NOT_FOUND</jshis:code>
        <jshis:message>No data is found for the query</jshis:message>
    </jshis:error>
</jshis:SstrctMeshinfo>

Category : API　

TOP > API > Shallow structure mesh information API

J-SHIS | Japan Seismic Hazard Information Station

Shallow structure mesh 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

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