Overview

Partially updates a scheduled item (e.g., a location, vehicle, or equipment record) identified by {scheduleId} in the {domain}. Only the fields included in the request body are modified on that scheduled item. Unspecified fields are left unchanged.

This endpoint does not modify the proposal itself. The {proposalId} in the route is used only to verify that the proposal is modifiable and that the scheduled item belongs to it. The fields in the request body must correspond to the scheduled item's domain, not the proposal entity.

The system validates the updated record after applying changes.

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 update a location's city:

PATCH /api/Quotes/Proposals/12345/Schedules/ProposalLocation/100
Content-Type: application/json

{
  "City": "Naperville",
  "ZipCode": "60540"
}

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

Scenario 2: Validation fails after applying changes:

PATCH /api/Quotes/Proposals/12345/Schedules/ProposalLocation/100
Content-Type: application/json

{
  "LocationName": ""
}

{
  "IsSuccessful": false,
  "RecordID": 0,
  "OrderNumber": null,
  "Message": "LocationName is required.",
  "Warnings": null
}