Managing dwelling incidents

A dwelling incident is an object that captures loss information about a place where people live. In the data model, DwellingIncident is a subtype of FixedPropertyIncident.

A dwelling incident typically includes an inline damageable called location, with fields that describe inherent qualities of the dwelling's location, such as address. The dwelling incident also contains additional information specific to the loss, such as damagedAreaSize and severity. You do not have to specify location when you create a dwelling incident. If you do want to specify location, you can either:

  • Specify an existing location on the policy by providing its policySystemId.
  • Specify an existing location on the claim by providing its ClaimCenter id.
  • Create a new location by providing its attributes inline.

Unlike some other child objects, a location cannot be created as a referenced resource in the included section and then specified by refid. A new location must be created as an inlined damageable.

Endpoints for managing dwelling incidents

Use the following endpoints to manage dwelling incidents:

  • GET /claims/{claimId}/dwelling-incidents
  • POST /claims/{claimId}/dwelling-incidents
  • GET /claims/{claimId}/dwelling-incidents/{incidentId}
  • PATCH /claims/{claimId}/dwelling-incidents/{incidentId}
  • DELETE /claims/{claimId}/dwelling-incidents/{incidentId}

For example, the following request creates a dwelling incident for claim cc:61. In the request, the inline damageable (the incident's location) is included, and it is specified by policySystemId.

POST /claim/v1/claims/cc:61/dwelling-incidents

{
    "data": {
        "attributes": {
            "description": "water from heavy rains leaked through the roof damaging walls and floor.",
            "location" : {
              "policySystemId" : "pcdwl:0001-1"
              } ,
	     "yearsInHome" : 7
        }
    }
}