Get Coverage Field Metadata from a Schedule Record

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

Returns field metadata for coverage-specific schedule (repeating data) domains within an insurance proposal. This endpoint is for special schedules where each schedule item is tied to a specific coverage or sub-coverage.

What is a Coverage Schedule? A coverage schedule is a repeating table where each row belongs to a specific insurance coverage. Unlike general schedules (locations, vehicles) that apply broadly to a proposal, coverage schedules are tightly coupled to individual coverages:

  • Equipment Schedule for Inland Marine Coverage: Each equipment item tied to a specific Inland Marine coverage
  • Building Schedule for Property Coverage: Each building tied to a specific Property coverage
  • Specialized Coverages: Schedules unique to specific coverage types

Key Difference from Regular Schedules:

  • Regular Schedule (LocationSchedule, VehicleSchedule): Items belong to the proposal/LOB overall
  • Coverage Schedule: Each item has a CoverageID field - belongs to a specific coverage
  • Sub-Coverage Schedule: Each item has both CoverageID and SubCoverageID - belongs to a specific sub-coverage

Key Concept:

Proposal (quote)
  └─ Inland Marine (LOB)
       ├─ Inland Marine Coverage #1 (coverage)
       │    └─ Equipment Schedule ← This endpoint
       │         ├─ Equipment A (CoverageID = 1)
       │         ├─ Equipment B (CoverageID = 1)
       │         └─ Equipment C (CoverageID = 1)
       │
       └─ Inland Marine Coverage #2 (coverage)
            └─ Equipment Schedule ← This endpoint
                 ├─ Equipment D (CoverageID = 2)
                 └─ Equipment E (CoverageID = 2)

When to Use This Endpoint

Use ProposalCoverageScheduleFields when:

  • ✅ Working with coverage-specific schedules (equipment, specialized items)
  • ✅ Each schedule item belongs to a particular coverage (has CoverageID)
  • ✅ Need metadata for schedules that vary by coverage type
  • ✅ Working with domains where ScheduleIsCoverageType = "Coverage" or "SubCoverage"

Use ProposalScheduleFields instead when:

  • ❌ Working with general schedules (locations, vehicles, drivers)
  • ❌ Schedule items don't belong to specific coverages
  • ❌ Schedule applies to proposal/LOB overall

Do NOT use this endpoint for:

  • ❌ Base proposal-level fields (use /api/MetaData/ProposalFields)
  • ❌ Coverage fields like limits/deductibles (use /api/MetaData/ProposalCoverageFields)
  • ❌ General schedules (use /api/MetaData/ProposalScheduleFields)
Query Params
integer
required

The existing Proposal record ID. Must be a real proposal - cannot simulate with hypothetical data.

string
required

The schedule domain name (e.g., "LocationSchedule", "VehicleSchedule", "BuildingSchedule", "DriverSchedule"). This identifies which type of schedule for which you are retrieving metadata.

integer
required

The Coverage ID (internal numeric ID, not display code). This identifies which specific coverage the schedule items belong to. Note: This is an integer ID, not a coverage code string.

integer

For sub-coverage schedules, the Sub-Coverage ID. Required if the schedule domain is a sub-coverage schedule.

integer

For state-specific schedules. If provided, returns state-specific fields and validations.

integer

For child schedules that have parent items. Provide the parent schedule item's ID for context.

string

Comma-separated list of specific fields to return. If omitted, returns all schedule fields. Example: "SerialNumber,Description,Value"

boolean

Exclude fields that are never applicable from the metadata result.

Response

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json