Get a Proposal's Applicable Coverages by Domain

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

For a specific coverage domain, returns the coverage options that are valid for the domain based on the proposal's policy configuration. For example, within the ProposalCLCoverage domain, this might return options like "Bodily Injury" and "Property Damage." Each item includes a key, display code, and description.

By default, coverages already added to the proposal are included in the results; set ignoreExisting=true to exclude them.

This endpoint is typically used as part of a workflow:

  1. Discover available domains — GET .../Coverages/Domains
  2. List the coverage options within a domain — this endpoint
  3. Add a coverage to the proposal — POST .../Coverages/{domain}

For the extended version of this endpoint that includes policy rules, mutual exclusivity, and prerequisites, see GET .../Coverages/{domain}/ApplicableEx.

Examples

Scenario 1: List applicable coverages for a location schedule:

GET /api/Quotes/Proposals/12345/Coverages/ProposalCLCoverage/Applicable?parentID=100&stateID=10
200 OK
[
  {
    "Key": 42,
    "DisplayCode": "BI",
    "Description": "Bodily Injury"
  },
  {
    "Key": 43,
    "DisplayCode": "PD",
    "Description": "Property Damage"
  }
]

Scenario 2: Exclude coverages already added to the parent:

GET /api/Quotes/Proposals/12345/Coverages/ProposalCLCoverage/Applicable?parentID=100&ignoreExisting=true
200 OK
[
  {
    "Key": 44,
    "DisplayCode": "UM",
    "Description": "Uninsured Motorist"
  }
]

Scenario 3: Domain is not a coverage type:

GET /api/Quotes/Proposals/12345/Coverages/ProposalLocation/Applicable
500 Internal Server Error
"Domain is not a coverage or subcoverage type: ProposalLocation"

Path Params
integer
required

The ID of the Proposal for which you are retrieving data.

string
required

The coverage domain name. Must be a domain whose type is Coverage or SubCoverage. Example: ProposalCLCoverage.

Query Params
integer

The ID of the parent schedule record. Required when the coverage domain has a parent relationship. Not required when the proposal itself is the parent.

integer

Filters the results to only include coverages applicable to the specified state. When omitted, state-based filtering is not applied.

boolean
Defaults to false

If true, the response will exclude any applicable coverages that are already added to the parent.
If false, the response will include all applicable coverages regardless of whether they are already added to the parent.

Response

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json