get
https://{environment}.origamirisk.com/OrigamiApi/api/MetaData/ProposalCoverageFields
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Overview
Returns field metadata for coverage-specific fields within an insurance proposal. While /api/MetaData/ProposalFields returns LOB-level fields (Workers Comp fields, Auto fields, etc.), this endpoint returns metadata for individual coverages within those lines of business.
What is a ProposalCoverage? A ProposalCoverage represents one specific insurance coverage within a proposal. For example:
- Within Workers Comp LOB: Employers Liability coverage
- Within Commercial Auto LOB: Auto Liability coverage, Auto Physical Damage coverage, Hired Auto coverage
- Within Commercial Property LOB: Building coverage, Business Personal Property coverage
Each coverage has its own set of fields for limits, deductibles, premiums, and coverage-specific options.
Key Concept:
Proposal (quote)
├─ Workers Comp (LOB)
│ ├─ WC Employers Liability (coverage) ← This endpoint
│ └─ WC Statutory (coverage) ← This endpoint
│
└─ Commercial Auto (LOB)
├─ Auto Liability (coverage) ← This endpoint
├─ Auto Physical Damage (coverage) ← This endpoint
└─ Hired Auto (coverage) ← This endpoint
When to Use This Endpoint
Use ProposalCoverageFields when:
- ✅ Building forms for specific coverages within a proposal (not the proposal itself)
- ✅ You need metadata for coverage-level fields:
Limit,Deductible,Premium,EffectiveDate,ExpiryDate - ✅ Working with the
ProposalCoveragedomain - ✅ Building multi-coverage forms where each coverage has different options
Do NOT use this endpoint for:
- ❌ Base proposal-level fields (use
/api/MetaData/ProposalFields) - ❌ LOB-specific proposal fields like Workers Comp payroll or Auto fleet info (use
/api/MetaData/ProposalFields) - ❌ Schedule data (locations, vehicles, etc.) - those have separate endpoints