Property Damage Ratio By Return Period

Property Damage By Return Period

returns property damage for location entries based on the return period

post/v1/location/property-damage/return-period

Request

  • Base URL: https://developer.oneconcern.com (the document declares no server; this is the origin it was published from)
  • URL: https://developer.oneconcern.com/v1/location/property-damage/return-period
  • Auth: none declared. Required headers: client-id

Headers

client-idstring required
Example:test-client-id
transaction-idstring
Example:test-transaction-id

Request body

latitudenumber required

The latitude used as part of the (lat,long) pair that is provided in requests/responses

longitudenumber required

The longitude used as part of the (lat,long) pair that is provided in requests/responses

max_distance_mnumber

The maximum distance from the provided (lat,long) pair to use when retrieving built object downtime statistics, bi risk scores or other metrics

peril'flood' | 'wind' | 'seismic' required

Peril for Return Period. Peril is the cause of downtime.

climate_change'ccbaseline' | 'cc2050_45' required

Average annual downtime climate change request enums

return_period_yrs50 | 100 | 250 | 500 | 1000 required

Time period of interest in years.

Note: - average annual defines time period as one year - these are the set of return period available for the V1 endpoints

Example request

{
  "latitude": 33.814437,
  "longitude": -118.051187,
  "max_distance_m": 100
}

Response

Successful Response

idstring required

ID (uuid) of the location

damage_ratio_avgnumber required

The direct structural impact of a hazard on a particular location of interest for risk analysis

damage_ratio_stdevnumber required

The standard deviation of the property damage for a particular location of interest for risk analysis

Changes

No recorded changes to this operation across all 1 revision of this API.