Overview of incidents in Cloud API
Cloud API supports the following incident resources:
- Dwelling incident
- Fixed property incident
- Property contents incident
- Other structure incident
- Injury incident
- Living expense incident
- Vehicle incident
For each incident type, there are typically five endpoints as described in the following table:
Operation | Endpoint | For the given claim... |
GET | /claims/{claimId}/incidentType |
Query for all incidents of incidentType |
POST | /claims/{claimId}/incidentType |
Create a new incident whose type is incidentType |
GET | /claims/{claimId}/incidentType/{incidentId} |
Query for the given incident |
PATCH | /claims/{claimId}/incidentType/{incidentId} |
Update the given incident |
DELETE | /claims/{claimId}/incidentType/{incidentId} |
Delete the given incident |
For example, the following endpoints interact with vehicle incidents:
- GET
/claims/{claimId}/vehicle-incidents
- POST
/claims/{claimId}/vehicle-incidents
- GET
/claims/{claimId}/vehicle-incidents/{incidentId}
- PATCH
/claims/{claimId}/vehicle-incidents/{incidentId}
- DELETE
/claims/{claimId}/vehicle-incidents/{incidentId}
assessment-content-items
endpoint
for items contained in the property.Operation | Endpoint | For the given claim... |
GET | /claims/{claimId}/property-contents-incidents/{incidentId}/assessment-content-items |
Query for all assessment content items contained in the property |
POST | /claims/{claimId}/property-contents-incidents/{incidentId}/assessment-content-items |
Create new assessment content items contained in the property |
GET | /claims/{claimId}/ property-contents-incidents/{incidentId}/ assessment-content-items /{contentItemsId} |
Query for specific assessment content items contained in the property |
PATCH | /claims/{claimId}/ property-contents-incidents/{incidentId}/ assessment-content-items /{contentItemsId} |
Update assessment content items contained in the property |
DELETE | /claims/{claimId}/
property-contents-incidents/{incidentId}/ assessment-content-items /{contentItemsId} |
Delete assessment content items contained in the property |
Primary child objects
Most types of incidents include an inlined "primary" child object that stores information that is inherent to the damaged thing from before it was damaged. For example:
- Dwelling incidents, fixed property incidents, and property contents incidents have a
location
object.- This stores information inherent to the location, such as
address
.
- This stores information inherent to the location, such as
- Injury incidents have an
injuredPerson
object.- This stores information inherent to the injured person, such as
firstName
andlastName
.
- This stores information inherent to the injured person, such as
- Vehicle incidents have a
vehicle
object.- This stores information inherent to the vehicle, such as
make
,model
, andlicenseplate
.
- This stores information inherent to the vehicle, such as
Information about the damage (such as the damage description or severity) are stored on the
incident, but not as part of this child object. For example, vehicle incidents have an
airbagsdeployed
field. This field is directly on the vehicle incident
itself, not on the vehicle
child object.
Incidents and risk units
There are two resources that can have "primary" child objects:
- Incidents, which are things that are lost or damaged (whether or not they were covered on the policy).
- Risk units, which are things covered on the policy associated with the claim (whether or not they have been lost or damaged).
A "primary" child object could be associated with only a risk unit, only an incident, or both a risk unit and an incident. Consider the following examples with vehicles and personal auto policies:
- A vehicle owned by the policyholder that was not damaged.
- This appears on the ClaimCenter copy of the policy as part of a vehicle risk unit.
- But because it was not damaged, there is no vehicle incident for this vehicle.
- A vehicle owned by a third party that was damaged.
- This does not appear on the ClaimCenter copy of the policy. (It may be covered on the third party's policy, but it is not covered on the policyholder's policy.) For this vehicle, there is no vehicle risk unit.
- But because it was damaged, there is a vehicle incident for this vehicle.
- A vehicle owned by the policyholder that was damaged.
- This appears on the ClaimCenter copy of the policy as part of a vehicle risk unit.
- This also appears as part of a vehicle incident because it was damaged.
Incompatible incident types
You cannot create an incident whose type is incompatible with the policy type. For example, you cannot create a dwelling incident on a claim associated with a personal auto policy. If you attempt to do so, the system APIs respond with an error message similar to the following:
{
"status": 404,
"errorCode": "gw.api.rest.exceptions.NotFoundException",
"userMessage": "No resource was found at path /claim/v1/claims/cc:34/dwelling-incidents"
}
For a given policy type, some insurers may have a business requirement that involves creating incidents that are incompatible with that policy type in the base configuration. For example, an insurer may have a business requirement to create fixed property incidents for inland marine policies, even though, in the base configuration, fixed property incidents are incompatible with inland marine policies. To implement this business requirement, the insurer must configure the ClaimCenter LOB typelists to make the incident type compatible with the policy type. For more information, see the Configuration Guide.