Get a Proposal's Applicable Coverages by Domain (Extended Version)

Time	Status	User Agent
Retrieving recent requests…

Overview

For a specific coverage domain, returns the individual coverage options that can be added to a proposal record — along with policy configuration rules such as whether each coverage is required, common, repeatable, mutually exclusive with others, or has prerequisites. Optionally includes field-level screen metadata for building dynamic forms.

This is the extended version of GET .../Coverages/{domain}/Applicable, which returns the same coverage options with only a key, display code, and description.

This endpoint is typically used as part of a workflow:

Discover available domains — GET .../Coverages/Domains
List the coverage options with policy rules — this endpoint
Add a coverage to the proposal — POST .../Coverages/{domain}

Examples

Scenario 1: List applicable coverages with screen metadata:

GET /api/Quotes/Proposals/12345/Coverages/ProposalCLCoverage/ApplicableEx?parentID=100&stateID=10&includeScreenMetaData=true

200 OK
[
  {
    "Key": 42,
    "DisplayCode": "BI",
    "Description": "Bodily Injury",
    "Sequence": 1,
    "IsCommon": true,
    "IsRequired": true,
    "CanRepeat": false,
    "MutuallyExclusiveIDs": [],
    "PrerequisiteIDs": [],
    "ScreenMetaData": {
      "Domain": "ProposalCLCoverage",
      "PolicyLineCode": null,
      "StateID": 10,
      "CoverageID": 42,
      "SubCoverageID": null,
      "ScreenLookupToken": "abc123",
      "Fields": [
        {
          "FieldName": "Limit",
          "DisplayName": "Coverage Limit",
          "DataType": "decimal"
        }
      ]
    }
  }
]

Scenario 2: List applicable coverages without screen metadata:

GET /api/Quotes/Proposals/12345/Coverages/ProposalCLCoverage/ApplicableEx?parentID=100

200 OK
[
  {
    "Key": 42,
    "DisplayCode": "BI",
    "Description": "Bodily Injury",
    "Sequence": 1,
    "IsCommon": true,
    "IsRequired": true,
    "CanRepeat": false,
    "MutuallyExclusiveIDs": [],
    "PrerequisiteIDs": [10]
  }
]

Scenario 3: Domain is not a coverage type:

GET /api/Quotes/Proposals/12345/Coverages/ProposalLocation/ApplicableEx

500 Internal Server Error
"Domain is not a coverage or subcoverage type: ProposalLocation"