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

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
response
data
cr1
Coefficient of risk (1.0 s)
crs
Coefficient of risk (0.2 s)
metadata
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

Example

Request

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

Response

{
  "request": {
    "date": "2017-09-20T20:50:24.327Z",
    "referenceDocument": "ASCE41-13",
    "status": "success",
    "url": "http://localhost/ws/designmaps/risk-coefficient.json?latitude=34&longitude=-118&referenceDocument=ASCE41-13",
    "parameters": {
      "latitude": 34,
      "longitude": -118
    }
  },
  "response": {
    "data": {
      "cr1": 0.93991,
      "crs": 0.92512
    },
    "metadata": {
      "spatialInterpolationMethod": "linearlinearlinear",
      "modelVersion": "v3.1.x",
      "regionName": "E2008R2_COUS0P01_Risk_Coefficient",
      "gridSpacing": 0.01
    }
  }
}