ReturnPeriodDto Json Schema

Contains the supporting objects and enums for the return period, which is an interval of time (in years).

ReturnPeriodDto

Contains the supporting objects and enums for the return period, which is an interval of time (in years).

aggregate : AggregateReturnPeriodDto

aggregateLoss : number (double)

Contains the aggregate loss based on all events that occurred during a year.

aggregateYear : integer (int32)

Specifies the year in the event catalog that the service used to compute the aggregate loss.

occurrence : OccurrenceReturnPeriodDto

occurrenceEvent : integer (int32)

Contains the event that produced the largest loss in the simulated year.

occurrenceLoss : number (double)

Contains the single largest loss caused by all events in the simulated year.

occurrenceModel : integer (int32)

Contains the model that produced the largest loss in the simulated year.

occurrencePerils : PerilDto

Contains all of the perils to include in a detailed loss analysis service request.

allLicensedPerils : boolean

Contains all licensed perils.

coastalFlood : boolean

Coastal flood

cropHail : boolean

Crop hail

earthquakeShake : boolean

Earthquake shake

fireFollowing : boolean

Fire following

hail : boolean

Hail

inlandFlood : boolean

Inland flood

landslide : boolean

Landslide

liquefaction : boolean

Liquefaction

multiPerilCrop : boolean

Multi-peril crop

pandemic : boolean

Pandemic flu

precipitationFlood : boolean

Precipitation flood

propertyDamage : boolean

Property damage (Cyber)

securityBreach : boolean

Security breach (Cyber)

severeThunderstorm : boolean

Severe thunderstorm

sprinklerLeakage : boolean

Sprinkler leakage

stormSurge : boolean

Storm surge

straightLineWinds : boolean

Straight line winds

terrorism : boolean

Terrorism

tornado : boolean

Tornado

tsunami : boolean

Tsunami

wildfire : boolean

Wildfire/bushfire

wind : boolean

Wind

winterStorm : boolean

Winter storm

occurrenceYear : integer (int32)

Contains the simulated year for which the occurrence loss is calculated.

returnPeriod : number (double)

Contains the expected value of the interval of time (in years) between years having greater or equal loss.

returnPeriodDetail : ReturnPeriodDetail

Contains the aggreate losses for all events that occurred during a year, or the single largest loss caused by all events in a year (occurrence).

Name	Description	Data Type
aggregate		AggregateReturnPeriodDto
aggregate\aggregateLoss	Contains the aggregate loss based on all events that occurred during a year.	number (double)
aggregate\aggregateYear	Specifies the year in the event catalog that the service used to compute the aggregate loss.	integer (int32)
occurrence		OccurrenceReturnPeriodDto
occurrence\occurrenceEvent	Contains the event that produced the largest loss in the simulated year.	integer (int32)
occurrence\occurrenceLoss	Contains the single largest loss caused by all events in the simulated year.	number (double)
occurrence\occurrenceModel	Contains the model that produced the largest loss in the simulated year.	integer (int32)
occurrence\occurrencePerils	Contains all of the perils to include in a detailed loss analysis service request.	PerilDto
occurrence\occurrencePerils\allLicensedPerils	Contains all licensed perils.	boolean
occurrence\occurrencePerils\coastalFlood	Coastal flood	boolean
occurrence\occurrencePerils\cropHail	Crop hail	boolean
occurrence\occurrencePerils\earthquakeShake	Earthquake shake	boolean
occurrence\occurrencePerils\fireFollowing	Fire following	boolean
occurrence\occurrencePerils\hail	Hail	boolean
occurrence\occurrencePerils\inlandFlood	Inland flood	boolean
occurrence\occurrencePerils\landslide	Landslide	boolean
occurrence\occurrencePerils\liquefaction	Liquefaction	boolean
occurrence\occurrencePerils\multiPerilCrop	Multi-peril crop	boolean
occurrence\occurrencePerils\pandemic	Pandemic flu	boolean
occurrence\occurrencePerils\precipitationFlood	Precipitation flood	boolean
occurrence\occurrencePerils\propertyDamage	Property damage (Cyber)	boolean
occurrence\occurrencePerils\securityBreach	Security breach (Cyber)	boolean
occurrence\occurrencePerils\severeThunderstorm	Severe thunderstorm	boolean
occurrence\occurrencePerils\sprinklerLeakage	Sprinkler leakage	boolean
occurrence\occurrencePerils\stormSurge	Storm surge	boolean
occurrence\occurrencePerils\straightLineWinds	Straight line winds	boolean
occurrence\occurrencePerils\terrorism	Terrorism	boolean
occurrence\occurrencePerils\tornado	Tornado	boolean
occurrence\occurrencePerils\tsunami	Tsunami	boolean
occurrence\occurrencePerils\wildfire	Wildfire/bushfire	boolean
occurrence\occurrencePerils\wind	Wind	boolean
occurrence\occurrencePerils\winterStorm	Winter storm	boolean
occurrence\occurrenceYear	Contains the simulated year for which the occurrence loss is calculated.	integer (int32)
returnPeriod	Contains the expected value of the interval of time (in years) between years having greater or equal loss.	number (double)
returnPeriodDetail	Contains the aggreate losses for all events that occurred during a year, or the single largest loss caused by all events in a year (occurrence).	ReturnPeriodDetail

Loss Analysis Service