Overview of modifiers
A modifier is a value used by the rating engine to adjust the policy premium (or some portion of it). Modifiers capture information relevant to pricing that are not necessarily tied to specific coverage or coverable. Modifiers are attached either to the line itself (such as a MultiPolicyDiscount modifier) or to a specific object, such as a vehicle (such as an AntiLockBreaks discount).
LOB-endpoint pattern for modifiers
Every line has endpoints to get a collection of modifiers, and to get or modify a modifier element. These endpoints follow these patterns:
- Line-level modifiers
- GET
/jobs/{jobId}/lines/{lineId}/modifiers
- GET
/jobs/{jobId}/lines/{lineId}/modifiers/{modifierId}
- PATCH
/jobs/{jobId}/lines/{lineId}/modifiers/{modifierId}
- GET
- Object-level modifiers
- GET
/jobs/{jobId}/lines/{lineId}/{objectName}/{objectNameId}/modifiers
- GET
/jobs/{jobId}/lines/{lineId}/{objectName}/{objectNameId}/modifiers/{modifierId}
- PATCH
/jobs/{jobId}/lines/{lineId}/{objectName}/{objectNameId}/modifiers/{modifierId}
- GET
For example, personal auto lines can have line-level modifiers and modifiers attached to vehicles. For a personal auto line, the endpoints to work with modifiers might be:
- Line-level modifiers
- GET
/jobs/{jobId}/lines/PersonalAutoLine/modifiers
- GET
/jobs/{jobId}/lines/PersonalAutoLine/modifiers/{modifierId}
- PATCH
/jobs/{jobId}/lines/PersonalAutoLine/modifiers/{modifierId}
- GET
- Object-level modifiers
- GET
/jobs/{jobId}/lines/PersonalAutoLine/vehicles/{vehicleId}/modifiers
- GET
/jobs/{jobId}/lines/PersonalAutoLine/vehicles/{vehicleId}/modifiers/{modifierId}
- PATCH
/jobs/{jobId}/lines/PersonalAutoLine/vehicles/{vehicleId}/modifiers/{modifierId}
- GET