Get List of a Proposal's Coverages by Domain

Time	Status	User Agent
Retrieving recent requests…

Overview

Returns the coverage records that currently exist on a proposal for a given domain. Unlike the Applicable and ApplicableEx endpoints, which return the catalog of valid coverage options, this endpoint returns the actual records that have been added to the proposal, with their field values (limits, deductibles, foreign keys, etc.).

Each record is returned as a dynamic key-value dictionary whose fields depend on the domain's schema. An optional filter string can narrow the results.

This endpoint is part of the coverage API workflow:

Purpose	Endpoint
Discover domains	`GET .../Coverages/Domains`
List valid options	`GET .../Coverages/{domain}/Applicable`
List valid options (extended)	`GET .../Coverages/{domain}/ApplicableEx`
List existing records	`GET .../Coverages/{domain}/Index` — this endpoint
Create	`POST .../Coverages/{domain}`
Update	`PATCH .../Coverages/{domain}/{id}`
Delete	`DELETE .../Coverages/{domain}/{id}`

Examples

Scenario 1: List all coverages for a domain:

GET /api/Quotes/Proposals/12345/Coverages/ProposalCLCoverage/Index

200 OK
[
  {
    "ProposalCLCoverageID": 501,
    "ProposalID": 12345,
    "CoverageID": 42,
    "Limit": 100000.00,
    "Deductible": 500.00
  },
  {
    "ProposalCLCoverageID": 502,
    "ProposalID": 12345,
    "CoverageID": 43,
    "Limit": 50000.00,
    "Deductible": 1000.00
  }
]

Scenario 2: Filter coverages by a parent record:

GET /api/Quotes/Proposals/12345/Coverages/ProposalCLCoverage/Index?filter=ProposalCLScheduleID==100

200 OK
[
  {
    "ProposalCLCoverageID": 501,
    "ProposalID": 12345,
    "ProposalCLScheduleID": 100,
    "CoverageID": 42,
    "Limit": 100000.00
  }
]

Scenario 3: Domain is not a coverage type:

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

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