Geohazard account

Geohazards location exposures associated with the specified account.

Exposures must be prepared prior to data analysis. Geohazarding is the process of running geocoding and hazarding jobs on location exposures.

The request body consists of an array of objects that define one or more geohazard jobs. Each object is defined by a name, type, engineType, and version:

  • The name parameter specifies the peril model. A peril model is a computer-based model that estimates losses from natural or man-made hazards, such as earthquakes, floods, hurricanes, and acts of terrorism.
  • The type parameter specifies the job type. One of geocode or hazard.
  • The version parameter specifies the version of the peril model.
  • The engineType specifies engine used to process the job.

The optional layerOptons object specifies options that apply to that layer. The Boolean skipPrevGeocoded attribute determines whether geocoding is rerun for this layer on previously geocoded locations.

In general, the first object specifies a geocode job, as identified in the type attribute. Subsequent objects define hazard lookup jobs.

[
   {
      "name": "geocode",
      "type": "geocode",
      "engineType": "RL",
      "version": "18.1",
      "layerOptions": {
      "skipPrevGeocoded": false,
      "aggregateTriggerEnabled": "false",
      "geoLicenseType": "0"
      }
   },
   {
      "name": "earthquake",
      "type": "hazard",
      "version": "18.1",
      "engineType": "RL",
      "layerOptions": {
      "skipPrevHazard": false,
      "overrideUserDef": false
      }
   }, 
   {
      "name": "windstorm",
      "type": "hazard",
      "version": "18.1",
      "engineType": "RL",
      "layerOptions": {
      "skipPrevHazard": false,
      "overrideUserDef": false
      }
  }
]

For each job, the name, type, engineType, and version parameters are required.

If successful, returns a 202 Accepted HTTP response and initates a GEOHAZ workflow job on the workflow engine.

📘

Idempotent requests

This service supports idempotent requests by means of idempotency keys. To learn more, see Idempotent Requests.

Language
Authentication
Header
URL