Canada Winterstorm Loss Cost 22.0

post https://{host}/li/ca_wt_loss_cost/22.0

Calculates loss cost metrics for locations using exposure data, financial details, and loss cost metrics in the Canada Winterstorm Loss Cost 22.0 data product.

Responses

Response body

object

warnings

array of objects

warnings

object

code

string

Warning codes:

Code	Description
FLG_4001	Layer option was skipped. Response based on its default value.
FLG_4002	Layer option was skipped. Response based on its maximum value.
FLG_4101	Hazard values are calculated based on default floodDepth.
FLG_4102	Hazard values are calculated based on maximum proximityDistance.
FLG_4103	No additional options can be provided to this lookup.
FLG_4201	Location not matched in ESDB building attributes database.
FLG_4202	Location is not eligible for ESDB building attribute return. Client input occupancy does not match ESDB occupancy.
FLG_4203	Location matched in ESDB building attributes database. Where values are not populated, they are not available in database.
FLG_4204	Insufficient geocoding information. Lookup will proceed with the default value for the missing field.
FLG_4205	The geocoding version used is not recommended for this layer.
FLG_4206	Input address has poor geocoding resolution. Response might have limited precision.
FLG_4207	The geocoding version used is not recommended for this layer at coarse geocoding resolutions (5 or higher).
FLG_4208	Insufficient geocoding information to look up requested data.
FLG_4301	No coverage values provided. Ground-up and gross loss cannot be calculated.
FLG_4302	One or more grossLoss values were not calculated due to invalid/missing deductibleAmount.
FLG_4304	Invalid/missing deductibleType. Valid deductibleTypes are 1 to 5.
FLG_4305	Deductible amount is treated as currency amount instead of percentage.
FLG_4306	Missing required field to perform gross loss calculations.
FLG_4307	Gross losses can only be calculated for reference view.
FLG_4400	[User input] is not a valid value for this layer option. Response based on default value.
FLG_4401	No data found for this location.
FLG_4500	The combination of input characteristics has not been found, no results have been provided.
FLG_4402	[LayerOption] is only valid for version 21 and has been ignored
FLG_4403	The location entered is outside of supported region, Response based on default value

message

string

buildingAlr

double

Building annualized loss rate

contentsAlr

double

Contents annualized loss rate

businessInterruptionAlr

double

Business interruption annualized loss rate

grossLoss

double

Loss to the insurer, accounting for the application of all insurance terms but without consideration for any reinsurance recoveries

groundUpLoss

double

Total loss to the exposure, independent of any insurance or reinsurance terms

grossLoss2

double

Loss to the insurer, accounting for the application of all insurance terms but without consideration for any reinsurance recoveries

grossLoss3

double

Loss to the insurer, accounting for the application of all insurance terms but without consideration for any reinsurance recoveries

Language

URL


xxxxxxxxxx
28
1
curl --request POST \
2
     --url https://api-euw1.rms.com/li/ca_wt_loss_cost/22.0 \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "location": {
8
    "address": {
9
      "countryScheme": "ISO2A"
10
    },
11
    "characteristics": {
12
      "construction": "ATC0",
13
      "occupancy": "ATC0",
14
      "yearBuilt": 0,
15
      "numOfStories": 0,
16
      "foundationType": 0,
17
      "firstFloorHeightAboveGround": 0,
18
      "basement": "DEFAULT",
19
      "floorArea": 0
20
    },
21
    "coverageValues": {
22
      "buildingValue": 0,
23
      "contentsValue": 0,
24
      "businessInterruptionValue": 0
25
    }
26
  }
27
}
28
'


xxxxxxxxxx
15
 
1
{
2
  "warnings": [
3
    {
4
      "code": "FLG_XXXX",
5
      "message": "Warning message"
6
    }
7
  ],
8
  "buildingAlr": 0.000863401691354315,
9
  "contentsAlr": 0.000358529682823589,
10
  "businessInterruptionAlr": 0.000559604863156912,
11
  "grossLoss": 750.16,
12
  "groundUpLoss": 901.43,
13
  "grossLoss2": 769.26,
14
  "grossLoss3": 817.11
15
}

200Everything worked as expected.

400The request was unacceptable, likely due to missing a required input.

401No valid API key provided.

500Something went wrong on our end (this happens rarely)