Peril Repository

Provide details on specific Perils individually or by Alert key. A Peril is a group of polygons for a given product at a given point in time in a given area. An Alert a set of perils that are logically related. For example, an Alert can contain multiple Perils that all happened for the same product at the same time but in different areas.

Peril metadata attributes:

  • perilKey: a UUID that uniquely identifies the peril.
  • alertKey: a UUID that uniquely identifies the alert, all perils in the same alert will share this key.
  • productCode: the product code for the peril.
  • timestamp: an ISO 8601 formatted UTC timestamp indicating when the perils were introduced into the system.
  • attributes: a map containing properties specific to the peril product type.
  • numberOfFeatures: a number indicating how many polygons a peril has
get
Get an individual Peril by Peril Key

Retrieve a single peril.

get
get

Product Catalog

Provides a listing of the products offered by the impact assessment platform.

get
Full Product Listing

Retrieves the full product listing, with details and descriptions.

get
Product Code Listing

Retrieves a simple list of the valid product codes that can be used in the Perils specification when creating an Org.

Organization

The Organization is the container assets and their subscriptions.

Organization attributes:

  • ticker: (abbreviation, ticker symbol, short name)
  • enabled: participates in matching
  • perils: list of weather perils to which the Org is to be subscribed
  • endpoints: list of delivery endpoints for the asset impact payloads.

Rules:

("may not be null" = tag must be supplied in JSON)

  • ticker
    • may not be null
    • format must match [a-z][a-z0-9_]*
    • may not be changed
  • classifying values
    • enabled defaults to true if not included
    • if the JSON for Org modification posts does not include tags for these values, the existing information will not be overwritten:
  • perils and endpoints
    • may not be null
    • but can be an empty array ([ ])
    • specifying empty array for either will cause the Org to not be involved in peril matching
    • Org modifications may specify empty arrays to remove existing perils and endpoints
post
Create Org

Specify the details of a new Org. Upon successful validation and success pinging any endpoints supplied, the Org is created. The responses reflects the saved information and supplies the Org's API-Key.

Secured by Partner API-Key header
put
Modify Org

The Organization can also use the API to change anything but its ticker. The Org API-Key specified in the header is used to identify and retrieve the existing Org, so the ticker need not be specified in this request, and is ignored if present. The rules around what can be excluded from the JSON, and the behavior based on what you specify, are outlined above. The response reflects the Org state after the changes, and includes validation information in the same way the "create org" response does.

delete
Delete Org by ticker

Delete an Org, and empty it's Assets. Does not preclude you from recreating an Org with the same ticker in the future.

Secured by Partner API-Key header
get
Get Org

Retrieve details for Org with provided apiKey path variable.

Secured by Partner API-Key header
get
Get all Orgs

Retrieve details for all Orgs.

Secured by Partner API-Key header

Subscription

An Org's subscription list is the products for which the Org wants impacts on its Assets assessed.

get
Find out which Orgs are subscribed to a Peril

Finds all Orgs that are subscribed to a given Peril, and are enabled, and returns a list of their tickers.

Secured by Partner API-Key header

Assets

Assets are points (lat/lon) supplying a Reference ID which is meaningful to the Asset Owner.

Asset Attributes:

  • wsiId: asset ID assigned by WSI (not specified in create, but is required for modify and delete).
  • refId: Reference Id
  • lat: Latitude
  • lon: Longitude
post
Create a new Asset

Takes a asset definition and attempts to create it, returning how it ended up being stored in the system. Created Assets receive a separate ID from WSI (referred to herein as assetId or wsiId) which is used in all subsequent interactions regarding that Asset (modifying the lat/lon or the Reference ID, or deleting the Asset).

put
Modify asset refId or location details

Change the lat/lon and/or refId of an Asset. This endpoint expects a complete re-specification of all pieces of information. Any missing or malformed information will constitute a validation error.

get
Get Asset details by assetId (wsiId)

Retrieve the details of the asset associated with the specified wsiId.

delete
Delete Asset

Delete the Asset. The response returns the wsiId of the affected Asset.

get
Get Asset details by refId

Retrieve the details of the assets associated with the specified refId.

post

Quickly delete all assets.

post
Bulk upload of assets for an Org

Separate from the atomic asset operations, the API supports the upload of a tsv (tab-separated-values) file to bulk-load the assets contained in it.

Each line in the tsv can contain 1, 3, or 4 non-empty fields. The number of fields determines the operation performed. Any characters after a # character on a line will be ignored. This is so that the failed-lines file (which contains error messages after #) can be reuploaded after errors are fixed.

If the reload parameter is specified (true), the assets for the org will be completely truncated prior to uploading the file. in this case, of course, specifying updates and deletes in the file would be erroneous.

Inserts
  • refId: Reference Id
  • lon: Longitude
  • lat: Latitude
Updates
  • wsiId: asset ID assigned by WSI
  • refId: Reference Id
  • lon: Longitude
  • lat: Latitude
Deletes
  • wsiId: asset ID assigned by WSI
get
Retrieval of the status of a bulkload request

Upon the successful submission of a bulkload request, a bulkloadRequestId is returned. Calling this endpoint with that bulkloadRequestId returns the status of the upload, which includes a URL that can be used to download the failures file if there are any, as well as a link to a file detailing the successfully inserted Assets.

NOTE that the URLs returned for the download of either the inserted assets or failed lines files are designed to direct you to the /storage endpoint below. That endpoint does require the Org's API-Key header.

Storage

Storage is the resource Orgs will use to retrieve files specified in the payload when 6082887803 of a previously submitted bulk load.

get
Download a file