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

Optional parameters

siteClass: Site class corresponding to the specific area/region
Example: BC

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
siteClass: Site class corresponding to the specified area/region
Example: “BC”

response

data

curveInterpolationMethod: Identifier for the interpolation method used to obtain data for location of interest from datasets.
modelVersion: Identifier for the underlying model version in the database
periods: Identifier for the period values associated with the corresponding value
pgadPercentileFactor: Factor applied 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)
sadFloor: Object containing array of floor values (ordinates) and array of periods. The ordinates are the minimum constraint placed on the deterministic ground motion at times specified in the sadFloor 'periods' array
sauhMaxDirFactor: Object containing array of direction ground motion values (ordinates) and array of periods. The ordinates are the factor applied to the geometric mean ground motion to get max direction ground motion at times specified in the 'periods' array
sadPercentileFactor: Object containing array of target percentile ground motion values (ordinates) and array of periods. The ordinates are the factor applied to 50% ground motion to achieve target percentile ground motion at times specified in the 'periods' array
spatialInterpolationMethod: Identifier for the interpolation method used to obtain data for location of interest from underlying gridded datasets
vs30: Identifier for the vs30 region specified

Example

Request

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

Response

{
  request:{
      date:"2019-05-28T17:31:43.205Z",
      referenceDocument:"ASCE7-16",
      status:"success",
      url:"http://localhost:8000/ws/designmaps/metadata.json?referenceDocument=ASCE7-16&latitude=34&longitude=-118&siteClass=BC",
      parameters:{
        latitude:34,
        longitude:-118,
        siteClass:"BC"
      }
  },
  response:{
      data:{
        vs30:760,
        modelVersion:"v4.0.x",
        pgadFloor:0.5,
        pgadPercentileFactor:1.8,
        sadFloor:{
            periods:[
              0.2,
              1
            ],
            ordinates:[
              1.5,
              0.6
            ]
        },
        sadPercentileFactor:{
            periods:[
              0.2,
              1
            ],
            ordinates:[
              1.8,
              1.8
            ]
        },
        maxDirectionFactor:{
            periods:[
              0.2,
              1
            ],
            ordinates:[
              1.1,
              1.3
            ]
        },
        spatialInterpolationMethod:"linearloglinear"
      }
  }
}