Lines

A line is a set of LOB-specific resources owned by a job or policy.

For most types of resources, every resource has a unique ID. However, the value of a line instance's ID is set to the LOB's identifier as specified in the product definition. For example, suppose there is a personal auto line whose identifier is set to "PersonalAutoLine". This means that, for every personal auto job and policy, the ID of the line resource is "PersonalAutoLine".

A line resource can have the following direct descendent children:

  • Line-level coverages
  • Coverables
  • Other line-specific objects, such as exposures and exclusions (For example, a person auto line could include driver exposures)

LOB-endpoint pattern for lines

For each LOB, there are endpoints to get, modify, and delete a line resource. They follow these patterns:

  • GET /jobs​/{jobId}​/lines​/{lineId}
  • PATCH /jobs​/{jobId}​/lines​/{lineId}
  • DELETE /jobs​/{jobId}​/lines​/{lineId}

For example, for a personal auto line, the endpoints might be:

  • GET /jobs​/{jobId}​/lines​/PersonalAutoLine
  • PATCH /jobs​/{jobId}​/lines​/PersonalAutoLine
  • DELETE​ /jobs​/{jobId}​/lines​/PersonalAutoLine

For information on how to generate LOB-specific endpoints, see the Cloud API Developer Guide. The examples in this section of the documentation use endpoints from the base configuration Personal Auto product. For information on how to generate these endpoints, see the Cloud API Developer Guide.

Creating and modifying lines

Lines are created automatically when the job is created.

  • If the product is a single-line product, that line is created by default. There are no POST or DELETE endpoints for the line.
  • If the product is a multi-line product, all lines are created by default. There are POST and DELETE endpoints so you can modify which lines are attached to the policy as needed.

The line resource specifies its pattern and pattern code. Beyond this, the amount of information on the line resource itself varies from line to line. Some lines may store only a small amount of information on the line resource itself. Others may have a more robust amount of information.

For example, the following response comes from a GET for a line resource for the base configuration Personal Auto LOB. All fields are included.

        "attributes": {
            "coverableJurisdiction": {
                "code": "CA",
                "name": "California"
            },
            "numAddInsured": 0,
            "pattern": {
                "displayName": "Personal Auto Line",
                "id": "PersonalAutoLine"
            },
            "patternCode": "PersonalAutoLine"
        },