API Explorer 1.0
API Explorer 1.0
Description
Contains the Catalog Viewer API Services and all included schema.
All Operations
Get/api/Catalogs
This call enables you to retrieve a list of available catalogs.
Get/api/Catalogs/{catalogId}/GetAvailableEventIntensities
This call enables you to retrieve available intensity footprints for an event. The application allows you to track the storm surge intensity footprints and windspeed intensity of the selected events on the map. Similarly, you can automate this workflow using this API endpoint. For example: you can search for an event using the QueryEventsByIds API and filter the events that interest you using the QueryEventsByFilters API, and then use these results in the GetAvailableEventIntensities call to obtain the full track of the specific events.
Post/api/Catalogs/{catalogId}/QueryEventDataAttributesByFilters
This call enables you to filter events by criteria and query data attributes for each event.
Post/api/Catalogs/{catalogId}/QueryEventDataAttributesByIds
This call enables you to retrieve the data attributes for a selected set of events. You can fetch the event track on the map for the selected events and the landfall characteristics.
Get/api/Catalogs/{catalogId}/QueryEventIndustryLossGeographiesById
Get event industry loss geography information
Get/api/Catalogs/{catalogId}/QueryEventInfoAttributesById
This call returns a set of event parameters for each hourly point in the storm track for an event.
Get/api/Catalogs/{catalogId}/QueryEventInfoById
This call provides a summary of events.
Post/api/Catalogs/{catalogId}/QueryEventsByFilters
This call enables you to find events in the stochastic catalog data that meet your specific set of event attributes.
Post/api/Catalogs/{catalogId}/QueryEventsByIds
This call enables you to obtain the event information associated with an event identifier. An event identifier is a system-generated unique numerical identifier of the event. You can specify more than one event identifier at a time and fetch their corresponding events information.
Get/api/SpatialDataLayers
Retrieve a list of spatial data layers for a given category
Get/api/SpatialDataLayers/Layer/Download
Downloads an image of the target spatial data layer
Get/api/SpatialDataLayers/Layer/GetFeatureInfo
Gets feature information of spatial data layer
Get/api/SpatialDataLayers/Layer/GetFeatures
(Required) Defines features of the spatial data layer
Get/api/SpatialDataLayers/Layer/GetImage
Retrieve a spatial data layer image
Get/api/SpatialDataLayers/Layer/GetLegend
Defines legend details of the spatial data layer
Get/api/SpatialDataLayers/Options
This service enables you to fetch a list of spatial data layer options available for a given vendor.
Json Schemas
The bounding box (BBOX) or envelope is an expression of the maximum extents of a two-dimensional object (e.g. point, line, polygon) or set of objects within its (or their) two-dimensional (x, y) coordinate system, in other words min(x), max(x), min(y), max(y).
Specifies catalog metadata object
Specifies the result type of an event industry loss and associated geographic representation
Specifies type for an event intensity footprint
Represents a collection of features
Represents geometric features such as points, lines, curves, or surfaces. For example: a square constructed with lines.
Represents spatial data type that is mapped on a two-dimensional flat surface
Represents a collection of geometries
Represents result type for hourly point attribute
Represents type for keyword list
Represents result type for landfall attribute
Represents a spatial data layer
Indicates the enumeration of the layer category
Represents map image bounding box
Indicates the error information associated with the API service call
Represents search by event identifiers
Represents the data transfer object of the spatial data layer
Represents the layer style
Represents the result type of event track summary attributes
Represents the source of the spatial data that is used in the layer