Get Screen Metadata for Multiple Proposal Records

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

Overview

Returns field metadata for multiple existing records at once within a single proposal. This endpoint is specifically designed for bulk editing scenarios where you need to render multiple editable records in a single grid, and each row may have different metadata based on its specific record context.

  • Record's current field values triggering different formulas
  • Record's state or other contextual data
  • Record-specific applicability rules
  • Record-specific required field logic

Why This Matters: In a bulk editing grid, Row 1 and Row 2 might have different required fields, different applicable fields, or different dropdown options based on each record's current state. This endpoint provides per-row metadata so your grid can render correctly for each record.

Key Use Case:

Location Schedule Bulk Edit Grid
┌─────────────────────────────────────────────────────┐
│ Location 1 (Active)      │ StateID is required      │
│ Location 2 (Inactive)    │ StateID is read-only     │
│ Location 3 (Pending)     │ StateID is editable      │
└─────────────────────────────────────────────────────┘
   ^                           ^
   Each row has               Different metadata
   different data             per row context

When to Use This Endpoint

Use ProposalMultiRowFields when:

  • ✅ Building a bulk edit grid where multiple records are editable simultaneously
  • ✅ Each record in the grid may have different metadata based on its context
  • ✅ You want to avoid making separate metadata calls for each row (performance optimization)
  • ✅ Working with schedule domains or other multi-record scenarios

Use other metadata endpoints instead when:

  • ❌ Getting metadata for a new record form (use ProposalFields, ProposalScheduleFields, etc.)
  • ❌ Getting metadata for a single existing record (use ProposalFields with id parameter)
  • ❌ Records don't exist yet (this endpoint requires existing record IDs)

Do NOT use this endpoint for:

  • ❌ Creating new records (records must already exist)
  • ❌ Form metadata where context doesn't vary by record
  • ❌ More than 100 records at once (hard limit)

Query Params
integer
required

The existing Proposal ID that these records belong to.

string
required

The domain of the records (e.g., "LocationSchedule", "VehicleSchedule", "ProposalCoverage"). All records must be from the same domain.

string
required

The ids parameter contains the primary keys of the specific domain instances for which you are retrieving metadata. These are NOT proposal IDs. For example:

  • domain="LocationSchedule" → IDs are LocationIDs (e.g., 100, 101, 102)
  • domain="VehicleSchedule" → IDs are VehicleIDs (e.g., 501, 502, 503)
  • domain="ProposalCoverage" → IDs are ProposalCoverageIDs (e.g., 200, 201, 202)
  • domain="DriverSchedule" → IDs are DriverIDs (e.g., 301, 302, 303)
string

The Line of Business code (e.g., "CA" for Commercial Auto, "WC" for Workers Comp). If provided, returns LOB-specific schedule fields. If omitted, returns generic schedule fields.

string

Comma-separated list of specific fields to return. If omitted, returns all fields. Example: "Address,City,StateID"

boolean
Defaults to true

If true and fieldList is specified, marks fields NOT in fieldList as read-only.

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