Risk Coefficient Endpoint Documentation

This endpoint returns ratios of risk-targeted divided by uniform-hazard ground motions, known as risk coefficients. The risk-targeted ground motions are for a target probability of structural collapse corresponding to 1% in 50 years. The uniform-hazard ground motions correspond to a probability of ground motion exceedance of 2% in 50 years.

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 fetch results
Example: 34
longitude: Longitude for location at which to fetch results
Example: -118
referenceDocument: Design code reference document corresponding to hazard dataset for which to fetch results
Example: ASCE41-13
siteClass: [Optional] NEHRP site class identifying the site class of the risk coefficient data to retrieve
Example: BC

Output

Web service response

request

date

Timestamp
Example: “YYYY-MM-DDThh:mm:ssZ”

referenceDocument

Design code reference document corresponding to hazard dataset for returned results
Example: “ASCE41-13”

status

String (“success” or “error”)
Example: “success”

url

URL to reproduce this result
Example: “…/risk-coefficient.json?latitude=34&longitude=-118&referenceDocument=ASCE41-13”

parameters

latitude: Latitude for location at which to fetch results
Example: 34
longitude: Longitude for location at which to fetch results
Example: -118
siteClass: NEHRP site class for which to fetch results.
Example: “BC”

response

data

cr

periods: Array of spectral periods corresponding to the coeffient of risk ordinates
ordinates: Array of coefficient of risk values (ordinates) corresponding to the spectral periods

metadata

gridSpacing: The grid spacing (decimal degrees) for the underlying dataset
modelVersion: Identifier for the underlying model version in the database
regionName: Identifier for the underlying region name in the database
spatialInterpolationMethod: Identifier for the interpolation method used to obtain data for location of interest from underlying gridded datasets
vs30: The time-averaged shear-wave velocity to 30 m depth for which the returned coefficient of risk values apply

Example

Request

…/risk-coefficient.json?latitude=34&longitude=-118&referenceDocument=ASCE41-13&siteClass=BC

Response

{
  request:{
      date:"2019-05-28T17:42:47.156Z",
      referenceDocument:"ASCE41-13",
      status:"success",
      url:"http://localhost:8000/ws/designmaps/risk-coefficient.json?referenceDocument=ASCE41-13&latitude=34&longitude=-118&siteClass=BC",
      parameters:{
        latitude:34,
        longitude:-118,
        siteClass:"BC"
      }
  },
  response:{
      data:{
        cr:{
            periods:[
              0.2,
              1
            ],
            ordinates:[
              0.92512,
              0.93991
            ]
        }
      },
      metadata:{
        gridSpacing:0.01,
        modelVersion:"v3.1.x",
        regionName:"E2008R2_COUS0P01_Risk_Coefficient",
        spatialInterpolationMethod:"linearlinearlinear",
        vs30:760
      }
  }
}