Overview

Returns the coverage domains (the categories of coverages and subcoverages) that apply to the requested proposal, based on its assigned policy lines and policy set. This is a discovery endpoint; it does not return individual coverage options.

The response includes the DomainName value, which can be supplied as the {domain} path parameter in other Coverages endpoints (such as GET .../Coverages/{domain}/Applicable).

Notes

• Coverages are distinct from scheduled items: schedules represent what is insured (locations, vehicles), coverages represent the terms under which they are insured.
• The ParentDomainName and ParentIDField indicate the hierarchy. For example, a subcoverage domain's parent is a coverage domain, and a coverage domain's parent is typically a schedule domain.

Examples

Scenario 1: Retrieve available coverage domains:

GET /api/Quotes/Proposals/12345/Coverages/Domains

200 OK
[
  {
    "DomainName": "ProposalCLCoverage",
    "DisplayNameSingular": "CL Coverage",
    "DisplayNamePlural": "CL Coverages",
    "PrimaryKeyField": "ProposalCLCoverageID",
    "ParentDomainName": "ProposalCLSchedule",
    "ParentIDField": "ProposalCLScheduleID",
    "IsSubCoverage": false
  },
  {
    "DomainName": "ProposalCLSubCoverage",
    "DisplayNameSingular": "CL Sub Coverage",
    "DisplayNamePlural": "CL Sub Coverages",
    "PrimaryKeyField": "ProposalCLSubCoverageID",
    "ParentDomainName": "ProposalCLCoverage",
    "ParentIDField": "ProposalCLCoverageID",
    "IsSubCoverage": true
  }
]

Scenario 2: Proposal has no coverage domains configured:

GET /api/Quotes/Proposals/99999/Coverages/Domains

200 OK
[]