API Explorer 1.0
Get/api/Catalogs
API Explorer 1.0 > All Operations Resource Group : /api/Catalogs (Get)
Description
This call enables you to retrieve a list of available catalogs.
Parameters
NameDescriptionData Type
Indicates the current API versionstring
200 Response

The response body is of type Array[CatalogDto].

Contains a list of catalogs

Overview

Array[CatalogDto]
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
Fault Responses
FaultDescription
This fault returns a response body of type ProblemDetails.
Enter a valid Tenant Id or license information.
See Also
All Operations Resource GroupAPI Explorer 1.0