Parameters----------peril : dict ``name`` (required), ``code``, ``aplus_code`` (up to 11 characters), ``lexis_nexis_code`` (up to 5), and the ISO ClaimSearch and XactAnalysis lookup values ``iso_claimsearch_loss_cause_code`` and ``xactanalysis_type_of_loss_code``, each one of the active values ``get_peril_code_settings`` lists. The name and code are stored exactly as sent, spaces included: claim imports match perils by name. The ISO APlus and LexisNexis codes are trimmed and upper-cased, and a blank lookup value is stored as none.Returns-------dict The peril, as ``list_perils`` returns it.
create_peril › Request Body
object · required
create_peril › Responses
200
success
boolean · required
required
Messages or errors related to the request
object · required
delete_peril
POST
/api/v2/perils/delete_peril
Delete a peril. It is also taken off every claim, peril group, catastrophe and adjuster
assignment config that uses it.
Which integration codes a peril shows on this site, and the values each can pick from.
Code
Returns-------dict * ``aplus_code_enabled``: the "ISO APLUS Reporting" vendor is on. * ``lexis_nexis_code_enabled``: the "Lexis Nexis C.L.U.E Property (Loss History)" vendor is on. * ``iso_claimsearch_loss_causes``: the ISO ClaimSearch loss causes (``code``, ``label``, ``active``), or null while ISO ClaimSearch is not connected. * ``xactanalysis_types_of_loss``: the XactAnalysis types of loss, the same way, or null while no XactAnalysis integration is connected.
get_peril_code_settings › Request Body
get_peril_code_settings › Responses
200
success
boolean · required
required
Messages or errors related to the request
object · required
list_perils
POST
/api/v2/perils/list_perils
Every peril, by name, with all of its codes.
Code
Returns-------list ``id``, ``name``, ``code``, ``aplus_code``, ``lexis_nexis_code``, ``iso_claimsearch_loss_cause_code`` and ``xactanalysis_type_of_loss_code``.
list_perils › Request Body
list_perils › Responses
200
success
boolean · required
required
Messages or errors related to the request
object[] · required
update_peril
POST
/api/v2/perils/update_peril
Change a peril.
Code
Parameters----------peril_id : strperil : dict The fields to change, as ``create_peril`` takes them; a field left out keeps its value. A lookup value the peril already has stays allowed after it is deactivated.Returns-------dict The peril, as ``list_perils`` returns it.