In BriteCore, the Lines module provides a dynamic interface for administrators to set up coverages, including effective dates, business locations, line items, sublines, components, policy types, rate chains, and underwriting.
This tutorial will walk you through retrieving product definitions for classic BriteCore using BriteAPIs.
Note: For auto-related policy information, refer to the BriteLines tutorial guide.
Key concepts
- Data Fields: Data fields define what data to collect. Fields describe facts about a risk. Available fields are determined by our client and used within Risk groups. Risk types are parents of fields.
- Effective dates: Effective dates provide a chronological reference for managing versions of your coverages (lines of business or LOBs) and rates. Effective dates serve as a historical record of changes over time.
- Forms: Insurance forms are legal agreements that specify the details on the policy contract between the carrier and the policyholder. Line items are the parents of forms. When a Line Item is added to a policy, the forms are also attached to the policy and displayed on the Declaration page.
- Items: Coverages, fees associated with a risk. The association between a risk and the insurance that applies to that risk is captured in line items. All items associated with a risk or policy group are displayed through a selection UX.
- Line of business (LOB): A LOB describes the product or set of related products that make up a particular insurance offering. It describes a type of insurance. LOBs are the highest hierarchical entity in a Lines configuration.
- Subline: A subline is a collection of line items.
- Line items: Line items are individual items on a policy, which can be a coverage, endorsement, rider, or exclusion. Line items determine which coverage is or isn’t included in a policy. BriteCore currently has six types of line items: coverage, adjustment, non-rate, fee, calculation, and dividend.
- Policy type: Policy type is a flexible term. It refers to either a line of business or a form within a line of business, depending upon your setup. Insurance agencies and agents may refer to a policy type as an insurance product or insurance package.
- Rating: Rating calculates the premium and fees due on a policy.
- Risks: Risks represent individual exposures that may be insured on a policy.
- Risk type: Defines what you are insuring (for example, a type of property). A risk type models the fields, rate tables, calculations, and line items that follow a particular type of risk. Lines are parents of risk types.
- Underwriting rules: Underwriting rules use triggers, effects, and logic to add or remove line items or category options when a user selects a specified option while building a policy.
Retrieve product definition
Note: Blocks of code are hidden by default to make the page more navigable. Select View code and Hide code to view or hide these sections as needed.
Step 1: Get a security token
You will need to request an ID and Secret to use OAuth 2.0.
For more information, refer to How do I get started?
Step 2: List product and product types available
Use the find_effective_date endpoint to available products and policy types based on effective date. You must pass the effective date.
Sample request
curl --location --request POST '/api/v2/lines/find_effective_date' \
|
Sample response
"data": {
|
Step 3: Retrieve policy type details
Use the retrieve_policy_type endpoint to retrieve information about a policy type. You must pass policy_type_id.
Sample request
curl --location --request POST '/api/v2/lines/retrieve_policy_type' \
|
Sample response
{
|
Step 4: Retrieve all effective dates
Use the get_all_effective_dates endpoint to retrieve a list of all effective dates for all lines stored in BriteCore.
Sample request
curl --location --request POST '/api/v2/lines/get_all_effective_dates' \
|
Sample response
{
|
Step 5: Retrieve lines details for an effective date
The endpoint get_all_lines returns a list of all lines for a particular effective date. You must pass effective_date_id from step 4.
Sample request
curl --location --request POST '/api/v2/lines/get_all_lines' \
|
Sample response
{
|
Step 6: Retrieve all policy types for an effective date
Use the get_all_policy_types endpoint to retrieve all the policy types for an effective date. Pass the location_id and effective_date_id from step 5.
Sample request
curl --location --request POST '/api/v2/lines/get_all_policy_types' \
|
Sample response
{
|
Step 7: Export product line definition
The get_export_line_file endpoint retrieves file date for exporting a line. Pass the following parameters:
curr_line_id : str, requiredThe line id.curr_eff_date_id : str, requiredThe effective date id,curr_state_id : str, requiredThe state idinclude_custom_sequences : bool, optionalWhether or not to include any non-default data from custom_sequences that is associated with the policy types |
Sample request
curl --location --request POST '/api/v2/lines/get_export_line_file' \
|
Sample response
{
|
Step 8: Export product line definition
The import_line endpoint allows you to import a LOB, including all the policy types. Include the following parameters:
{
|
Sample request
curl --location --request POST '/api/v2/lines/import_line' \
|
Sample response
{
|