Vehicle damage points

A vehicle incident can have one or more associated vehicle damage points. A vehicle damage point is an indication of a single point of damage done to the vehicle. A vehicle damage point has two fundamental attributes:

  • DamagePoint, which is a typekey to the VehicleDamagePoints typelist and which identifies the location of the damage

  • DamageSeverity, which is a typekey to the DamageSeverity typelist and which optionally identifies the severity of the damage

For more information on the business functionality of vehicle damage points, see the Application Guide.

Querying for vehicle damage points

Use the following endpoints to query for the damage points on a vehicle incident.

  • GET /claim/v1/claims/{claimId}/vehicle-incidents/{incidentId}/
vehicle-damage-points
  • GET /claim/v1//claims/{claimId}/vehicle-incidents/{incidentId}/
vehicle-damage-points/{vehicleDamagePointId}

For example, the following request retrieves the vehicle damage points for vehicle cc:1010 on claim demo_sample:1.

Command

GET /claim/v1/claims/demo_sample:1/vehicle-incidents/cc:1010/vehicle-damage-points

Response

{
    "count": 2,
    "data": [
        {
            "attributes": {
                "damagePoint": {
                    "code": "fr_door",
                    "name": "Front Right Door"
                },
                "damageSeverity": {
                    "code": "moderate",
                    "name": "Moderate"
                },
                "id": "cc:SwZ6FuftaXwcyOWRs6kG2"
            },
            ...
        },
        {
            "attributes": {
                "damagePoint": {
                    "code": "f_bumper",
                    "name": "Front Bumper and Grill"
                },
                "id": "cc:SRlArWMDZmtKA8TScCZ3x"
            },
            ...
        }
    ],
    ...
}

Creating vehicle damage points

Use the following endpoint to create a vehicle damage point:

  • POST /claim/v1/claims/{claimId}/vehicle-incidents/{incidentId}/
vehicle-damage-points

The only required field is damagePoint.

For example, the following request creates a vehicle damage point for vehicle cc:1010 on claim demo_sample:1 to indicate minor roof damage. Note that the request provides the required damagePoint value and the optional damageSeverity value.

Command

POST /claim/v1/claims/demo_sample:1/vehicle-incidents/cc:1010/vehicle-damage-points

Request

{
  "data": {
    "attributes": {
        "damagePoint": {
            "code": "roof"
        },
        "damageSeverity": {
            "code": "minor"
        }
    }
  }
}

PATCHing and DELETEing vehicle damage points

Use the following endpoint to PATCH an existing damage point:

  • PATCH /claim/v1/claims/{claimId}/vehicle-incidents/{incidentId}/
vehicle-damage-points/{vehicleDamagePointId}

For example, the following request modifies the severity of damage point cc:9999 for vehicle cc:1010 on claim demo_sample:1.

Command

PATCH /claim/v1/claims/demo_sample:1/vehicle-incidents/cc:1010/vehicle-damage-points/cc:9999

Request

{
  "data": {
    "attributes": {
        "damageSeverity": {
            "code": "severe"
        }
    }
  }
}

Use the following endpoint to DELETE an existing damage point:

  • DELETE /claim/v1/claims/{claimId}/vehicle-incidents/{incidentId}/
vehicle-damage-points/{vehicleDamagePointId}

For example, the following request deletes damage point cc:9999 for vehicle cc:1010 on claim demo_sample:1.

Command

DELETE /claim/v1/claims/demo_sample:1/vehicle-incidents/cc:1010/vehicle-damage-points/cc:9999