Overview

Deletes a scheduled item from a proposal. The behavior depends on the proposal type:

• Endorsement proposals: The record is soft-deleted. A policy change entry is created to track the deletion. The record can be restored using POST /api/Quotes/Proposals/{proposalId}/Schedules/{domain}/{scheduleId}/Reinstate.

• Non-endorsement proposals (Quote, Application, Renewal, Rewrite, Reissue): The record is permanently deleted from the database, and Data Entry Events (DEEs) fire after deletion.

Preconditions

The proposal must be modifiable. A proposal cannot be modified when:

• Its status is Bound (B), Rejected (R), or Cancelled (0).
• Its proposal set is bound.
• It has a pending expiry date change endorsement.

The domain must be a valid schedule domain for the proposal.

Examples

Scenario 1: Successfully delete a location:

DELETE /api/Quotes/Proposals/12345/Schedules/ProposalLocation/100

{
  "IsSuccessful": true,
  "RecordID": 100,
  "OrderNumber": null,
  "Message": "Delete schedule with id 100 successfully.",
  "Warnings": null
}

Scenario 2: Proposal is not modifiable:

DELETE /api/Quotes/Proposals/12345/Schedules/ProposalLocation/100

{
  "IsSuccessful": false,
  "RecordID": 0,
  "OrderNumber": null,
  "Message": "Cannot modify Proposal with ID# 12345.",
  "Warnings": null
}