API Reference

Remove Schedules Linked to Proposal

delete
https://{environment}.origamirisk.com/OrigamiApi/api/Quotes/Proposals//LinkedSchedules//Remove
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

Removes cross-references between items on different schedules within the same proposal. This does not delete the scheduled items themselves; it only removes the association between them.

You specify:

  • subjectDomain + subjectID - the record to remove cross-references from (e.g., ProposalLocation 100)
  • {domain} + ids - the records to un-cross-reference (e.g., ProposalVehicle 200,201)

If ids is empty or null, no cross-references are removed and the endpoint returns success without making any changes.

Examples

Scenario 1: Remove the cross-reference between a location and two vehicles:

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

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

DELETE /api/Quotes/Proposals/99999/LinkedSchedules/ProposalVehicle/Remove?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 un-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 removing cross-references from. Example: ProposalLocation.

string
required

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 un-cross-reference from the subject. Example: 200,201,202 (three vehicles).

Response
200

The ProposalID

Updated about 2 months ago

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

Updated about 2 months ago