Site Amplification Documentation

This endpoint returns site amplification data.

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

referenceDocument
Design code reference document corresponding to hazard dataset for which to fetch results
Example: ASCE7-10
siteClass
NEHRP site classification
Example: D
s1
MCER ground motion (1.0 s)
ss
MCER ground motion (0.2 s)

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: /site-amplification.json?s1=0.824&ss=2.307&pga=2.3&referenceDocument=ASCE7-10&siteClass=D
parameters
siteClass
NEHRP site classification
Example: D
s1
MCER ground motion (1.0 s)
ss
MCER ground motion (0.2 s)
pga
MCEG peak ground acceleration
response
data
fa
Site amplification factor (0.2 s)
fa_note
Site amplification factor message (0.2s)
fpga
Site amplification factor at PGA
fpga
Site amplification factor at PGA message
fv
Site amplification factor (1.0 s)
fv_note
Site amplification factor message (1.0 s)
metadata

Example

Request

/site-amplification.json?s1=0.824&ss=2.307&pga=2.3&&referenceDocument=ASCE7-10&siteClass=D

Response

{
  "request": {
    "date": "2017-10-16T23:06:37.678Z",
    "referenceDocument": "ASCE7-10",
    "status": "success",
    "url": "http://localhost/ws/designmaps/site-amplification.json?s1=0.824&ss=2.307&&pga=2.3&referenceDocument=ASCE7-10&siteClass=D",
    "parameters": {
      "s1": "0.824",
      "ss": "2.307",
      "pga": "2.3",
      "siteClass": "D"
    }
  },
  "response": {
    "data": {
      "fa": 1,
      "fv": 1.5,
      "fpga": 1
    },
    "metadata": {}
  }
}