J-SHIS Web API
Version
Table of contents
Summary
Prerepuisite knowledge
Service
– Information Service APIs
– Search Service APIs
Summary
J-SHIS Web API allows developers/applications to obtain various hazard information, that is displayed in J-SHIS Map, with mesh shape.
J-SHIS Web API supports for showing hazard information in your web page, and for making mobile application to find seismic faults which affect on the current mesh position.
There are two types of the HTTP response format as shown in the table.
Format | Response |
---|---|
GML/GeoJSON | With the mesh shape |
XML/JSON | Without the mesh shape |
Prerequisite knowledge
J-SHIS Web API assumes that you have some knowledge of the following formats.
– XML ( http://www.w3schools.com/xml/default.asp )
– GML ( http://www.opengeospatial.org/standards/gml )
– JSON ( http://www.json.org/ )
– GeoJSON ( http://geojson.org/ )
Service
All services are used by sending an HTTP GET request to the URL in the following format:
Information Service API
Information Service API obtains categorized information of J-SHIS with RESTful requests.
Service name | postfix |
---|---|
Seismic hazard information API (with 250 mesh) |
pshm/*/*/*/meshinfo.*?* |
*/pshm/*/*/*/meshinfo.* | |
Hazard curve information API (without mesh information) |
pshm/*/*/*/*/hzcv.*?* |
*/pshm/*/*/*/*/hzcv.* | |
Seismic activity model information API (with fault shape) |
pshm/*/*/*/fltinfo.*?* |
Averaged hazard information API (with 250 mesh) |
avghzd/*/meshinfo.*?* |
*/avghzd/*/meshinfo.* | |
Shallow structure mesh information API (with 250 mesh) |
sstrct/*/meshinfo.*?* |
*/sstrct/*/meshinfo.* | |
Shallow Soil Condition properties API (without mesh information) |
sstrct/*/phys.* |
Deep subsurface structural information API (with third mesh) |
dstrct/*/*/meshinfo.*?* |
*/dstrct/*/*/meshinfo.* | |
Deep subsurface structural physical properties API (without mesh information) |
dstrct/*/phys.* |
Landslide information API (with 250 mesh) |
landslide/isContaining.json?* |
*/landslide/isContaining.json?* |
Note) “*” represents a wildcard character, that changes by the request content. For more information, see each service page.
Search Service API
Search Service API searches and provides information in J-SHIS.
Service name | postfix |
---|---|
Damaging Fault Search API for mesh | fltsearch?meshcode=* |
fltsearch?position=* | |
*/fltsearch?* | |
Damaging Fault Search API for municipality | fltsearch?areacode=* |
A*/fltsearch?* | |
Mesh Search API | meshsearch?* |
A*/meshsearch?* |
Note) “*” represents a wildcard character, that changes by the request content. For more information, see the each service page.