api.v2.lines module

api.v2.lines.find_effective_date(date)[source]
api.v2.lines.retrieve_effective_date(effective_date_id)[source]

Retrieves information about an effective date.

Parameters:None
Returns:
  • success (bool) – True if successful, false if not
  • messages (list of str) – List of human-readable error messages
  • data (dict) – The data response having the form:
    {
        'id': UUID,
        'description': str,
        'creation_date': 'YYY-MM-DD',
        'effective_date': 'YYYY-MM-DD',
        'change_history': [],
        'override_lock': bool,
        'states': [
            {
                'id': UUID,
                'name': str,
                'abbreviation': str,
                'counties': [{}],
                'county_specifications': [{}]
            }
        ],
        'underwriting_questions': [
            {
                'id': UUID
                'effective_id': UUID,
                'policy_type_id': NULL,
                'inheritance_id': UUID,
                'order': int,
                'yes_no_explain': ('yes', 'no', 'none'),
                'yes_no_question': str,
                'yes_no_prevent_continue': ('yes', 'no', 'none')
            }
        ],
        'lines': [
            {
                'effective_id': UUID,
                'location_id': UUID,
                'name': str,
                'system_tags': {},
                'policy_types': [
                    {
                        'id': UUID,
                        'name': str,
                        'description': str,
                        'system_tags': {},
                        'location_id': UUID,
                        'sort_order': int,
                        'multiple_property_status': bool,
                        'open_to_quoting': bool,
                        'three_year': bool,
                        'three_year_quote': bool,
                        'one_year': bool,
                        'one_year_quote': bool,
                        'nine_month': bool,
                        'nine_month_quote': bool,
                        'six_month': bool,
                        'six_month_quote': bool,
                        'three_month': bool,
                        'three_month_quote': bool,
                        'underwriting_options': [
                            {
                                'id': UUID,
                                'policy_type_id': UUID,
                                'inheritance_id': UUID,
                                'errorMessage': str,
                                'order': int,
                                'question': str,
                                'options': [{
                                    'id': UUID,
                                    'allowed': bool,
                                    'description': str,
                                    'option_code': str
                                }]
                            }
                        ],
                        'underwriting_questions': [
                            {
                                'id': UUID,
                                'effective_id': UUID,
                                'policy_type_id': UUID,
                                'inheritance_id': UUID,
                                'order': int,
                                'yes_no_question': str,
                                'yes_no_explain': ('yes', 'no', 'none'),
                                'yes_no_prevent_continue': ('yes', 'no', 'none')
                            },
                        ]
                    }
                ]
            }
        ]
    }
    
api.v2.lines.retrieve_policy_type(policy_type_id=None)[source]

Retrieves information about a policy type.

Parameters:policy_type_id (UUID) –
Returns:
  • success (bool) – True if successful, false if not
  • messages (list of str) – List of human-readable error messages
  • data (dict) – The data response having the form:
    {
        'id': UUID,
        'app_id': str
        'line_id': UUID,
        'effective_id': UUID,
        'location_id': UUID,
        'inheritance_id': UUID,
        'name': str,
        'description': str,
        'underwriting': str,
        'sort_order': int,
        'multiple_property_status': bool,
        'open_to_quoting': bool,
        'three_year': bool,
        'three_year_quote': bool,
        'one_year': bool,
        'one_year_quote': bool,
        'nine_month': bool,
        'nine_month_quote': bool,
        'six_month': bool,
        'six_month_quote': bool,
        'three_month': bool,
        'three_month_quote': bool,
        'dec_display_options': str,
        'three_year_factor': Decimal('0.0000'),
        'one_year_factor': Decimal('0.0000'),
        'nine_month_factor': Decimal('0.0000'),
        'six_month_factor': Decimal('0.0000'),
        'three_month_factor': Decimal('0.0000'),
        'system_tags': {}
        'protection_class': ('ISO', 'AAIS'),
        'separate_dec_sections': bool,
        'location': {
            'id': UUID,
            'abbreviation': str,
            'checked': bool,
            'counties': [],
            'county_specifications': [],
            'life_cycle_parameters': ('same', 'definedPer')
            'name': str
        },
        'deductible_groups': [
            {
                'id': UUID,
                'effective_id': UUID,
                'inheritance_id': UUID,
                'name': str,
                'deductibles': {
                    'roundMethod': ('ROUND_HALF_UP', 'ROUND_CEILING', 'ROUND_FLOOR'),
                    'roundTo': str
                    'data': [
                        {
                            'modification': str,
                            'amount': str,
                            'defaultDeductible': bool,
                            'unit': ('Dollar', 'Factor')
                        }
                    ]
    
                }
            }
        ]
        'items': [
            {
                'id': UUID,
                'allow_multiples': bool,
                'category': ('policy', 'property'),
                'description': str,
                'has_limit': bool,
                'has_rate': bool,
                'limit_availability': str,
                'mandatory': bool,
                'name': str,
                'show_in_builder': bool,
                'sort_order': int,
                'required_for_quote': bool
                'type': ('coverage', 'adjustment', 'nonRate', 'fee',
                         'calculation', 'dividend')
            }, ...
        ]
        'sub_lines': [
            {
                'id': UUID,
                'inheritance_id': UUID,
                'category': ('policy', 'property'),
                'default': bool,
                'mandatory': bool,
                'allow_multiples': bool,
                'name': str,
                'policy_type_id': UUID,
                'sort_order': int,
                'description': str,
                'type': ('liability', 'inland marine', 'property'),
                'items': [...] # see items definition above
            }, ...
        ],
        'line_item_groups': [
            {
                'id': UUID,
                'policy_type_id': UUID,
                'name': str,
                'sort_order': int,
                'items': [...] # see items definition above
            }, ...
        ],
        'underwriting_rules': [
            {
                'id': UUID,
                'policy_type_id': UUID,
                'name': str,
                'description': str,
                'category': ('policy', 'property'),
                'exceptionType': (null, 'include', 'exclude'),
                'exceptionAgencies': null or ['agencyId1', 'agencyId2', ...],
                'renewal_only': bool,
                'sort_order': int,
                'triggers': [
                    {
                        'id': UUID
                        'underwriting_rule_id': UUID,
                        'policy_type_item_id': UUID,
                        'sort_order': int,
                        'category': str,
                        'value': [str, ...]
                    }
                ]
                'effects': [
                    {
                        'id': UUID
                        'underwriting_rule_id': UUID,
                        'policy_type_item_id': UUID,
                        'target_id': UUID,
                        'action': ('Add Line Item', 'Add Sub Line',
                                   'Add Optional Line Item',
                                   'Remove Line Item', 'Remove Sub Line',
                                   'Remove Optional Line Item', 'Remove Optional Sub Line',
                                   'Remove Category Option', 'Remove Deductible Option',
                                   'Set Category Option')
                        'sort_order': int,
                        'category': str,
                        'value': str,
                        'mandatory': bool,
                        'hard_reverse': bool,
                        'hide_category': bool
                    }
                ]
            }
        ],
        'underwriting_options': [
            {
                'id': UUID,
                'policy_type_id': UUID,
                'inheritance_id': UUID,
                'errorMessage': str,
                'order': int,
                'question': str,
                'options': [{
                    'id': UUID,
                    'allowed': bool,
                    'description': str,
                    'option_code': str
                }]
            }
        ],
        'underwriting_questions': [
            {
                'id': UUID,
                'effective_id': UUID,
                'policy_type_id': UUID,
                'inheritance_id': UUID,
                'order': int,
                'yes_no_question': str,
                'yes_no_explain': ('yes', 'no', 'none'),
                'yes_no_prevent_continue': ('yes', 'no', 'none')
            },
        ]
    }