OptionsDto Json Schema

Contains all user-specified output options for a detailed loss analysis.

OptionsDto

Contains all user-specified output options for a detailed loss analysis.

catalogs : Array[CatalogOptionDto]

Contains the list of catalog options.

model : string

Contains a code to represent the model.

size : CatalogSize

Contains the maximum number of years in the catalog.

tagType : CatalogTagType

Contains the subtype of an event catalog.

type : CatalogType

Contains the type of an event catalog: stochastic, historic, and World Scenarios.

demandSurge : boolean

Contains the demand surge options.

perilOptions : PerilOptionsDto

earthquake : EarthquakeDto

inducedEvents : boolean

Specifies earthquake-induced events, used for the U.S. models only.

precipitationFlood : PrecipitationFloodDto

percentage : number (float)

Contains the precipitation flood percentage.

sourceOfFlooding : SourceOfFloodingDto

offFloodPlain : boolean

Off flood plain.

onFloodPlain : boolean

On flood plain.

stormSurge : StormSurgeDto

percentage : number (float)

Contains the storm surge percentage.

resultSet : ResultSetOptionsDto

annualDetail : Array[AnnualDetailOptionsDto]

Contains a list of annual detail.

coverages : Array[Coverage]

Contains a list of coverages.

epAnnualTypes : Array[EPAnnualType]

Contains a list of exceedance probability (EP) annual types.

financialPerspectives : Array[FinancialPerspective]

Contains a list of financial perspectives.

perils : 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

targetTypes : Array[TargetType]

Contains a list of target types.

annualSummary : Array[AnnualSummaryOptionsDto]

Contains a list of annual aummary.

coverages : Array[Coverage]

Contains a list of coverages.

epAnnualTypes : Array[EPAnnualType]

Contains a list of EP annual types.

financialPerspectives : Array[FinancialPerspective]

Contains a list of financial perspectives.

perils : 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

returnPeriods : Array[number (double)]

Contains a list of return periods

targetTypes : Array[TargetType]

Contains a list of target types.

averageAnnualLoss : Array[AverageAnnualLossOptionsDto]

Contains a list of average annual loss (AAL).

coverages : Array[Coverage]

Contains a list of coverages.

epAnnualTypes : Array[EPAnnualType]

Contains a list of EP annual types.

financialPerspectives : Array[FinancialPerspective]

Contains a list of financial perspectives.

perils : 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

targetTypes : Array[TargetType]

Contains a list of target types.

eventDetail : Array[EventDetailOptionsDto]

Contains a list of event detail.

coverages : Array[Coverage]

Contains a list of coverages associated with a location or a contract in the detailed loss analysis request.

financialPerspectives : Array[FinancialPerspective]

Contains a list of financial perspectives associated with the detailed loss analysis request.

perils : 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

targetTypes : Array[TargetType]

Contains a list of target types.

Name	Description	Data Type
catalogs	Contains the list of catalog options.	Array[CatalogOptionDto]
demandSurge	Contains the demand surge options.	boolean
perilOptions		PerilOptionsDto
perilOptions\earthquake		EarthquakeDto
perilOptions\earthquake\inducedEvents	Specifies earthquake-induced events, used for the U.S. models only.	boolean
perilOptions\precipitationFlood		PrecipitationFloodDto
perilOptions\precipitationFlood\percentage	Contains the precipitation flood percentage.	number (float)
perilOptions\precipitationFlood\sourceOfFlooding		SourceOfFloodingDto
perilOptions\precipitationFlood\sourceOfFlooding\offFloodPlain	Off flood plain.	boolean
perilOptions\precipitationFlood\sourceOfFlooding\onFloodPlain	On flood plain.	boolean
perilOptions\stormSurge		StormSurgeDto
perilOptions\stormSurge\percentage	Contains the storm surge percentage.	number (float)
resultSet		ResultSetOptionsDto
resultSet\annualDetail	Contains a list of annual detail.	Array[AnnualDetailOptionsDto]
resultSet\annualSummary	Contains a list of annual aummary.	Array[AnnualSummaryOptionsDto]
resultSet\averageAnnualLoss	Contains a list of average annual loss (AAL).	Array[AverageAnnualLossOptionsDto]
resultSet\eventDetail	Contains a list of event detail.	Array[EventDetailOptionsDto]

Loss Analysis Service