Creating catastrophes

Use the following endpoint to create a catatsrophe:

  • POST /admin/v1/catastrophes

Create a minimal catastrophe

When you use the Cloud API to create a catastrophe in ClaimCenter, you must provide a name and catastropheNumber, each in the form of a string. The catastropheNumber is a unique number you can use for sorting in ClaimCenter. You can specify your own or specify one generated by a legacy system or governing body.

For example, the following request creates a catastrophe with only a name and a catastropheNumber.

Command

POST /admin/v1/catastrophes

Request


{
    "data": {
        "attributes": {
            "name": "Hurricane Example",
            "catastropheNumber": "24X"
        }
    }
}

When your creation is successful, the API will return the created catastrophe.

Response


{
    "data": {
        "attributes": {
            "active": true,
            "catastropheNumber": "24X",
            "id": "xc:SAw_jS2RygUX4uS9idwqV",
            "name": "Hurricane Example",
            "scheduleBatch": false
        }
    }
}

When the API creates the catastrophe, it sets the catastrophe's active status to true and scheduleBatch setting to false, by default.

Create a typical catastrophe

When you create a typical catastrophe, you can specify values for the following additional fields:

  • description
  • active
  • catastropheValidFrom
  • catastropheValidTo
  • comments
  • scheduleBatch
  • type/code
Note: The code within type is a string that represents a TypeKey from a TypeList of available codes, so you can only use a value enumerated in that list. The only values you can use are iso or internal.

For example, the following request creates a typical catastrophe using some additional fields.

Request


{
    "data": 
        {
            "attributes": {
                "name": "Hurricane Example",
                "catastropheNumber": "24X",
                "description": "Hurricane Example",
                "comments": "Catastrophe Details for Hurricane Example",
                "catastropheValidFrom": "2024-01-25T00:00:00.000Z",
                "catastropheValidTo": "2024-01-29T00:00:00.000Z",
                "active": false,
                "scheduleBatch": false,
                "type": {
                    "code": "iso"
                }
            }
        }
}
Response

{
    "data": 
        {
            "attributes": {
                "active": false,
                "catastropheNumber": "24X",
                "catastropheValidFrom": "2024-01-25T00:00:00.000Z",
                "catastropheValidTo": "2024-01-29T00:00:00.000Z",
                "comments": "Catastrophe Details for Hurricane Example",
                "description": "Hurricane Example",
                "id": "xc:SAw_jS2RygUX4uS9idwqV",
                "name": "Hurricane Example",
                "scheduleBatch": false,
                "type": {
                    "code": "iso",
                    "name": "ISO"
                }
            }
        }
}