API Explorer 1.0
CatalogDto Json Schema
API Explorer 1.0 : CatalogDto Json Schema
Description
Specifies catalog metadata object
Overview
CatalogDto
Specifies catalog metadata object
catalogId : integer (int32)
Specifies the unique identifier of the catalog
catalogTypeCode : string
Contains the type of catalog associated with a catastrophic event such as Stochastic, Historic, and World Scenarios catalogs
catalogTagTypeCode : string
Contains the subtype of an event catalog
catalogName : string
Specifies the name of the catalog
catalogVersion : string
Specifies the catalog version number
modelId : integer (int32)
Specifies model ID associated with the catalog
modelCode : string
Represents the model code associated with the request
catalogModelCode : string
Represents the model code for each simulated event in the catalog
modelName : string
Specifies the model name
modelVersion : string
Specifies the model version
yearMax : integer (int32)
Maximum number of simulated years in the catalog
yearCount : integer (int32)
Total number of simulated years in the catalog
eventMax : integer (int32)
Maximum number of simulated events in the catalog
eventCount : integer (int32)
Total number of simulated events in the catalog
extent : string
Specifies regional extent that catalog covers
perilSetCode : integer (int32)
Numeric code for the single peril or a set of perils
Properties
NameDescriptionData Type
Specifies the unique identifier of the cataloginteger (int32)
Contains the type of catalog associated with a catastrophic event such as Stochastic, Historic, and World Scenarios catalogsstring
Contains the subtype of an event catalogstring
Specifies the name of the catalogstring
Specifies the catalog version numberstring
Specifies model ID associated with the cataloginteger (int32)
Represents the model code associated with the requeststring
Represents the model code for each simulated event in the catalogstring
Specifies the model namestring
Specifies the model versionstring
Maximum number of simulated years in the cataloginteger (int32)
Total number of simulated years in the cataloginteger (int32)
Maximum number of simulated events in the cataloginteger (int32)
Total number of simulated events in the cataloginteger (int32)
Specifies regional extent that catalog coversstring
Numeric code for the single peril or a set of perilsinteger (int32)
See Also
API Explorer 1.0