Add Schedules Linked to a Proposal

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

Overview

Creates cross-references between items on different schedules within the same proposal. The items must already exist on their respective schedules before they can be cross-referenced. This endpoint does not modify either item; it simply records the association between them.

Real World Use Cases

  • Record which vehicles are garaged at a given location.
  • Assign drivers to specific vehicles they are authorized to operate.
  • Associate equipment or machinery with the locations where they are housed.
  • Link buildings to the locations they occupy.

You specify:

  • subjectDomain + subjectID - a single schedule item to cross-reference against (e.g., ProposalLocation 100)
  • {domain} + ids - one or more items in a different schedule to add as a cross-reference (e.g., ProposalVehicle 200,201)

Examples

Scenario 1: Cross-reference two vehicles with a location:

POST /api/Quotes/Proposals/12345/LinkedSchedules/ProposalVehicle/Add?subjectDomain=ProposalLocation&subjectID=100&ids=200,201
200 OK (no response body)

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

POST /api/Quotes/Proposals/99999/LinkedSchedules/ProposalVehicle/Add?subjectDomain=ProposalLocation&subjectID=100&ids=200
500 Internal Server Error
"Record not found in Proposal."
Path Params
integer
required

The ID of the proposal.

string
required

(The "many" side.) The schedule type of the records being cross-referenced. The IDs in the ids query parameter must be records of this type. Example: ProposalVehicle.

Query Params
string
required

(The "one" side.) The schedule type of the single record you are cross-referencing against. Example: ProposalLocation.

string
required

(The "one" side.) The ID of that single record. Example: 100 (a specific location).

string
required

(The "many" side.) A comma-separated list of {domain} record IDs to cross-reference with the subject. Example: 200,201,202 (three vehicles).

If you pass an ID that does not exist, it is silently skipped with no error and no indication that it was ignored. The response will still be 200 OK

Response
200
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!