Business Interruption Risk Scores By Return Period

Business Interruption Risk Scores By Return Period

returns business interruption risk scores for location entries based on the return period

post/v1/location/business-interruption/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/business-interruption/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

interruption_type'integrated' | 'utility' | 'ingress_egress' | 'community' | 'repair_time' | 'ports' | 'airports' | 'bridges' | 'highways' required

Interruption type, also known as the dependency or lifeline, refers to the component of infrastructure that is essential to recovery. Please note that different countries and peril combinations may support different dependencies.

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

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

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

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

Example request

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

Response

Successful Response

idstring required

ID (uuid) of the location

downtime_avg_daysnumber required

The average downtime for a particular location of interest for risk analysis in days

downtime_stdev_daysnumber required

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

scorestring required

The risk score label applied to a particular location of interest for risk analysis

Example response

{
  "downtime_avg_days": 1.5,
  "downtime_stdev_days": 1.5,
  "score": "very_low"
}

Changes

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