Overview

Returns scheduled items of a specific domain that are linked to a specific scheduled item of a different domain. This is different from GET .../Schedules/{domain}/Index, which returns all scheduled items of a domain on a proposal.

Scheduled items on a proposal can be explicitly linked to each other across domains through a many-to-many relationship. For example, a commercial auto policy might have 10 locations and 50 vehicles, but only certain vehicles are garaged at certain locations. These vehicle-to-location associations are managed through linked schedules.

To use this endpoint, you provide:

• {domain} (route) - the type of records you want back (e.g., ProposalVehicle)
• subjectDomain (query) - the type of the record you're starting from (e.g., ProposalLocation)
• subjectID (query) - the specific record you're starting from (e.g., location ID 100)

The response contains only the {domain} records that have been explicitly linked to the subject record, not all records of that domain on the proposal.

Examples

Scenario 1: List vehicles linked to a specific location:

"For proposal 12345, give me all the vehicles linked to location 100"

GET /api/Quotes/Proposals/12345/LinkedSchedules/ProposalVehicle/Index?subjectDomain=ProposalLocation&subjectID=100

[
  {
    "ProposalVehicleID": 200,
    "ProposalID": 12345,
    "VIN": "1HGCM82633A004352",
    "Year": 2023,
    "Make": "Honda",
    "Model": "Accord"
  },
  {
    "ProposalVehicleID": 201,
    "ProposalID": 12345,
    "VIN": "2T1BURHE0FC123456",
    "Year": 2022,
    "Make": "Toyota",
    "Model": "Corolla"
  }
]

Scenario 2: No linked records exist:

"For proposal 12345, give me all the vehicles linked to location 100" - but no vehicles have been linked to that location.

GET /api/Quotes/Proposals/12345/LinkedSchedules/ProposalVehicle/Index?subjectDomain=ProposalLocation&subjectID=100

[]

Scenario 3: Subject record does not belong to the proposal:

"For proposal 99999, give me all the vehicles linked to location 100" - but location 100 doesn't belong to proposal 99999.

GET /api/Quotes/Proposals/99999/LinkedSchedules/ProposalVehicle/Index?subjectDomain=ProposalLocation&subjectID=100

500 Internal Server Error
"Record not found in proposal."