get
https://{environment}.origamirisk.com/OrigamiApi/api/MetaData/ProposalScheduleFields
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Overview
Returns field metadata for schedule (repeating data) domains within an insurance proposal. Schedules represent repeatable items that are quoted or rated, such as locations, vehicles, buildings, drivers, or equipment.
What is a Schedule? A schedule is a collection of similar items that need to be individually tracked within a proposal. Think of it as a "sub-table" or "child records" attached to the proposal:
- Location Schedule: Multiple insured locations (addresses, building values, etc.)
- Vehicle Schedule: Multiple vehicles in a commercial auto policy
- Driver Schedule: Multiple drivers covered by the policy
- Building Schedule: Multiple buildings at a location
- Equipment Schedule: Tools, machinery, or specialized equipment
Each schedule item has its own fields for tracking item-specific data (VIN numbers, addresses, equipment serial numbers, values, etc.).
Key Concept:
Proposal (quote)
└─ Commercial Auto (LOB)
├─ Auto Liability (coverage)
├─ Auto Physical Damage (coverage)
└─ Schedule Data:
├─ Location Schedule (repeating) ← This endpoint
│ ├─ Location #1: 123 Main St
│ ├─ Location #2: 456 Oak Ave
│ └─ Location #3: 789 Elm Blvd
│
└─ Vehicle Schedule (repeating) ← This endpoint
├─ Vehicle #1: 2020 Ford F-150
├─ Vehicle #2: 2021 Chevy Silverado
└─ Vehicle #3: 2019 Toyota Camry
When to Use This Endpoint
Use ProposalScheduleFields when:
- ✅ Building forms for schedule data (locations, vehicles, buildings, drivers, equipment)
- ✅ You need metadata for repeatable items within a proposal
- ✅ Working with schedule domains (not base proposal or coverage domains)
- ✅ Building grids/tables where each row is a schedule item
Do NOT use this endpoint for:
- ❌ Base proposal-level fields (use
/api/MetaData/ProposalFields) - ❌ Coverage-specific fields like limits and deductibles (use
/api/MetaData/ProposalCoverageFields) - ❌ One-time fields (those belong on the proposal or coverage level)