ASCE7-05 Web Service 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
riskCategory
Risk category for structure
Example: III
siteClass
NEHRP site classification
Example: C
title
Name for site/report
Example: Example

Output

Web service response

request
date
Timestamp
Example: “YYYY-MM-DDThh:mm:ssZ”
referenceDocument
Identifying the reference document for the returned data
Example: “ASCE7-05”
status
String ("success" or "error")
Example: “success”
url
URL to reproduce this result
Example: {MOUNT_PATH}/asce7-05.json?latitude=34&longitude=-118&riskCategory=III&siteClass=C&title=Example”
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
riskCategory
Risk category for structure
Example: “III”
siteClass
NEHRP site classification
Example: “C”
title
Name for site/report
Example: “Example”
response
data
ss
MCER ground motion (0.2 s)
fa
Site amplification factor (0.2 s)
sms
Site-modified spectral acceleration value (0.2 s)
sds
Numeric seismic design value (0.2 s)
sdcs
Seismic design category from SDS
s1
MCER ground motion (1.0 s)
fv
Site amplification factor (1.0 s)
sm1
Site-modified spectral acceleration value (1.0 s)
sd1
Numeric seismic design value (1.0 s)
sdc1
Seismic design category from SD1
sdc
Seismic design category from SDCS and SDC1
t-sub-l
Long-period transition period in seconds
sdSpectrum
Design horizontal response spectrum
smSpectrum
MCER horizontal response spectrum
metadata
spatialInterpolationMethod
Identifier for the interpolation method used to obtain data for location of interest from underlying gridded datasets

Example

Request

…/asce7-05.json?latitude=34&longitude=-118&riskCategory=III&siteClass=C&title=Example

Response

{
  "request": {
    "date": "2017-09-20T17:49:48.029Z",
    "referenceDocument": "ASCE7-05",
    "status": "success",
    "url": "http://localhost/ws/designmaps/asce7-05.json?latitude=34&longitude=-118&riskCategory=III&siteClass=C&title=Example",
    "parameters": {
      "latitude": 34,
      "longitude": -118,
      "riskCategory": "III",
      "siteClass": "C",
      "title": "Example"
    }
  },
  "response": {
    "data": {
      "ss": 2.123,
      "fa": 1,
      "sms": 2.123,
      "sds": 1.415,
      "sdcs": "",
      "s1": 0.784,
      "fv": 1.3,
      "sm1": 1.019,
      "sd1": 0.679,
      "sdc1": "",
      "sdc": "E",
      "t-sub-l": 8,
      "sdSpectrum": [
        [
          0,
          0.566
        ],
        [
          0.025,
          0.787
        ],
        [
          0.05,
          1.008
        ],
        [
          0.096,
          1.415
        ],
        [
          0.1,
          1.415
        ],
        [
          0.15,
          1.415
        ],
        [
          0.2,
          1.415
        ],
        [
          0.25,
          1.415
        ],
        [
          0.3,
          1.415
        ],
        [
          0.35,
          1.415
        ],
        [
          0.4,
          1.415
        ],
        [
          0.45,
          1.415
        ],
        [
          0.48,
          1.415
        ],
        [
          0.5,
          null
        ],
        [
          0.55,
          null
        ],
        [
          0.6,
          null
        ],
        [
          0.65,
          null
        ],
        [
          0.7,
          null
        ],
        [
          0.75,
          null
        ],
        [
          0.8,
          null
        ],
        [
          0.85,
          null
        ],
        [
          0.9,
          null
        ],
        [
          0.95,
          null
        ],
        [
          1,
          null
        ],
        [
          1.05,
          null
        ],
        [
          1.1,
          null
        ],
        [
          1.15,
          null
        ],
        [
          1.2,
          null
        ],
        [
          1.25,
          null
        ],
        [
          1.3,
          null
        ],
        [
          1.35,
          null
        ],
        [
          1.4,
          null
        ],
        [
          1.45,
          null
        ],
        [
          1.5,
          null
        ],
        [
          1.55,
          null
        ],
        [
          1.6,
          null
        ],
        [
          1.65,
          null
        ],
        [
          1.7,
          null
        ],
        [
          1.75,
          null
        ],
        [
          1.8,
          null
        ],
        [
          1.85,
          null
        ],
        [
          1.9,
          null
        ],
        [
          1.95,
          null
        ],
        [
          2,
          null
        ]
      ],
      "smSpectrum": [
        [
          0,
          0.849
        ],
        [
          0.025,
          1.181
        ],
        [
          0.05,
          1.512
        ],
        [
          0.096,
          2.123
        ],
        [
          0.1,
          2.123
        ],
        [
          0.15,
          2.123
        ],
        [
          0.2,
          2.123
        ],
        [
          0.25,
          2.123
        ],
        [
          0.3,
          2.123
        ],
        [
          0.35,
          2.123
        ],
        [
          0.4,
          2.123
        ],
        [
          0.45,
          2.123
        ],
        [
          0.48,
          2.123
        ],
        [
          0.5,
          null
        ],
        [
          0.55,
          null
        ],
        [
          0.6,
          null
        ],
        [
          0.65,
          null
        ],
        [
          0.7,
          null
        ],
        [
          0.75,
          null
        ],
        [
          0.8,
          null
        ],
        [
          0.85,
          null
        ],
        [
          0.9,
          null
        ],
        [
          0.95,
          null
        ],
        [
          1,
          null
        ],
        [
          1.05,
          null
        ],
        [
          1.1,
          null
        ],
        [
          1.15,
          null
        ],
        [
          1.2,
          null
        ],
        [
          1.25,
          null
        ],
        [
          1.3,
          null
        ],
        [
          1.35,
          null
        ],
        [
          1.4,
          null
        ],
        [
          1.45,
          null
        ],
        [
          1.5,
          null
        ],
        [
          1.55,
          null
        ],
        [
          1.6,
          null
        ],
        [
          1.65,
          null
        ],
        [
          1.7,
          null
        ],
        [
          1.75,
          null
        ],
        [
          1.8,
          null
        ],
        [
          1.85,
          null
        ],
        [
          1.9,
          null
        ],
        [
          1.95,
          null
        ],
        [
          2,
          null
        ]
      ]
    },
    "metadata": {
      "spatialInterpolationMethod": "linearlinearlinear"
    }
  }
}