Create geohaz job

Initiates a geohaz job that either geocodes or performs a hazard lookup of the specified account or porfolio exposure.

The request specified the job type (geocode or hazard), the name of the data product used, the engine type (HD or RL), and layer-specific options. Different parameters are required depending on the type of the request (geocode or hazard).

Geocode

A geocode job enriches a location exposure with geolocation data that precisely identifies the global coordinates of a site.

Geocoding is a prerequisite for all catastrophe modelling processes. A location may be geocoded at different resolution levels. The lower the resolution level, the more accurate the the location coordinates returned by the geocoding service.

The layerOptions object defines GEOHAZ job parameters for the specified layer (name).

{
  "resourceUri": "https://{host}/platform/riskdata/v1/exposures/1/portfolio/1",
  "resourceType": "portfolio",
  "settings": {
    "layers": [
      {
        "type": "geocode",
        "name": "geocode",
        "engineType": "RL",
        "version": 18,
        "layerOptions": {
          "geoLicenseType": "0",
          "aggregateTriggerEnabled": true,
          "skipPrevGeocoded": false
        }
      }
    ]
  }
}

The geoLicenseType, aggregateTriggerEnabled, and skipPrevGeocoded parameters must be specified in every geocode request.

Hazard

A hazardjob retrieves data about local conditions and potential hazards for the locations associated with the specified account or portfolio exposure.

Hazarding enriches a location exposure with risk data drawn from an RMS peril model database, a collection of site hazard values that characterize the vulnerability of a location to a catastrophe event. While some hazard data is required prior to analysis, other hazard data can be licensed and retrieved to help you further understand a location's risk. Hazard lookups are not performed for non-modeled countries.

Hazard requests support many different layers (e.g. name).

The layerOptions object defines GEOHAZ job parameters for the specified layer (name). For a descriptions of the supported data products, see Geohaz API Overview.

{
  "resourceUri": "https://{host}/platform/riskdata/v1/exposures/1/portfolio/1",
  "resourceType": "portfolio",
  "settings": {
    "layers": [
      {
        "type": "hazard",
        "name": "cs_risk_score",
        "engineType": "RL",
        "version": 18,
        "layerOptions": {
          "overrideUserDef": false,
          "skipPrevHazard": false
        }
      }
    ]
  }
}

The overrideUserDef and skipPrevHazard parameters must be specified in every hazard request.