Retrieve List of Scheduled Items for a Known Proposal and Domain Type

Time	Status	User Agent
Retrieving recent requests…

Overview

Returns the list of scheduled records for a given domain on a proposal. Each record is returned as a dictionary of field-name/value pairs, where the available fields depend on the domain's entity definition.

Use GET /api/Quotes/Proposals/{proposalId}/Schedules/Domains first to discover which schedule domains are available for a proposal and what the DomainName values are.

Examples

Scenario 1: Retrieve all locations for a proposal:

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

[
  {
    "ProposalLocationID": 100,
    "ProposalID": 12345,
    "LocationName": "Main Office",
    "Address1": "123 Main St",
    "City": "Chicago",
    "StateCode": "IL",
    "ZipCode": "60601"
  },
  {
    "ProposalLocationID": 101,
    "ProposalID": 12345,
    "LocationName": "Warehouse",
    "Address1": "456 Industrial Blvd",
    "City": "Gary",
    "StateCode": "IN",
    "ZipCode": "46401"
  }
]

Scenario 2: Filter locations by a specific field value:

GET /api/Quotes/Proposals/12345/Schedules/ProposalLocation/Index?filter=StateCode=="IL"

[
  {
    "ProposalLocationID": 100,
    "ProposalID": 12345,
    "LocationName": "Main Office",
    "Address1": "123 Main St",
    "City": "Chicago",
    "StateCode": "IL",
    "ZipCode": "60601"
  }
]

Scenario 3: Filter vehicles by a specific policy line:

GET /api/Quotes/Proposals/12345/Schedules/ProposalVehicle/Index?policyLineCode=CA

[
  {
    "ProposalVehicleID": 200,
    "ProposalID": 12345,
    "VIN": "1HGCM82633A004352",
    "Year": 2023,
    "Make": "Honda",
    "Model": "Accord"
  }
]

Scenario 4: No records exist:

GET /api/Quotes/Proposals/12345/Schedules/ProposalVehicle/Index

[]