Metadata Endpoint Documentation

This software is preliminary or provisional and is subject to revision. It is being provided to meet the need for timely best science. The software has not received final approval by the U.S. Geological Survey (USGS). No warranty, expressed or implied, is made by the USGS or the U.S. Government as to the functionality of the software and related material nor shall the fact of release constitute any such warranty. The software is provided on the condition that neither the USGS nor the U.S. Government shall be held liable for any damages resulting from the authorized or unauthorized use of the software.

Request Parameters

Required parameters

latitude
Latitude for location at which to compute composite results
Example: 34
longitude
Longitude for location at which to compute composite results
Example: -118
referenceDocument
Design code reference document corresponding to hazard dataset for which to fetch results
Example: ASCE7-10

Output

Web service response

request
date
Timestamp
Example: “YYYY-MM-DDThh:mm:ssZ”
referenceDocument
Identifying the reference document for the returned data
Example: “ASCE7-16”
status
String (“success” or “error”)
Example: “success”
url
URL to reproduce this result
Example: /metadata.json?latitude=34&longitude=-118&referenceDocument=ASCE7-16
parameters
latitude
Latitude for location at which to compute composite results
Example: 34
longitude
Longitude for location at which to compute composite results
Example: -118
response
data
modelVersion
Identifier for the underlying model version in the database
pgadPercentileFactor
Factor applyed to 50% ground motion to achieve target percentile ground motion (Peak Ground Acceleration)
pgadFloor
Minimum constraint placed on the deterministic ground motion (Peak Ground Acceleration)
s1MaxDirFactor
Factor applyed to the geometric mean ground motion to get max direction ground motion (1.0 s)
s1dPercentileFactor
Factor applyed to 50% ground motion to achieve target percentile ground motion (1.0 s)
s1dFloor
Minimum constraint placed on the deterministic ground motion (1.0 s)
ssMaxDirFactor
Factor applyed to the geometric mean ground motion to get max direction ground motion (0.2 s)
ssdPercentileFactor
Factor applyed to 50% ground motion to achieve target percentile ground motion (0.2 s)
ssdFloor
Minimum constraint placed on the deterministic ground motion (0.2 s)
spatialInterpolationMethod
Identifier for the interpolation method used to obtain data for location of interest from underlying gridded datasets

Example

Request

/metadata.json?latitude=34&longitude=-118&referenceDocument=ASCE7-16

Response

{
  "request": {
    "date": "2017-09-20T17:49:41.425Z",
    "referenceDocument": "ASCE7-16",
    "status": "success",
    "url": "http://localhost/ws/designmaps/metadata.json?latitude=34&longitude=-118&referenceDocument=ASCE7-16",
    "parameters": {
      "latitude": 34,
      "longitude": -118
    }
  },
  "response": {
    "data": {
      "modelVersion": "v4.0.x",
      "pgadFloor": 0.5,
      "pgadPercentileFactor": 1.8,
      "s1MaxDirFactor": 1.3,
      "s1dFloor": 0.6,
      "s1dPercentileFactor": 1.8,
      "spatialInterpolationMethod": "linearloglinear",
      "ssMaxDirFactor": 1.1,
      "ssdFloor": 1.5,
      "ssdPercentileFactor": 1.8
    }
  }
}