TL Endpoint Documentation

This endpoint returns TL Data given reference point data (longitude and latitude) and a reference document (i.e., ASCE7-10).

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: 49
longitude: Longitude for location at which to fetch results
Example: -95
referenceDocument: Design code reference document corresponding to hazard dataset for which to fetch results
Example: ASCE7-10

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: “…/tl.json?latitude=49&longitude=-95&referenceDocument=ASCE7-10”

parameters

latitude: Latitude for location at which to fetch results
Example: 49
longitude: Longitude for location at which to fetch results
Example: -95

response

data

tl: Long-period transition period in seconds

t-sub-l: DEPRECATED; Long-period transition period in seconds

metadata

regionName: Identifier for the underlying region name in the database

Example

Request

…/tl.json?latitude=49&longitude=-95&referenceDocument=ASCE7-10

Response

{
  request:{
      date:"2019-05-28T18:01:16.857Z",
      referenceDocument:"ASCE7-10",
      status:"success",
      url:"http://localhost:8000/ws/designmaps/tl.json?referenceDocument=ASCE7-10&latitude=49&longitude=-95",
      parameters:{
        latitude:49,
        longitude:-95
      }
  },
  response:{
      data:{
        tl:4,
        t-sub-l:4
      },
      metadata:{
        regionName:"TL"
      }
  }
}