post
https://{environment}.origamirisk.com/OrigamiApi/api/Quotes/Proposals//Schedules/
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Overview
This endpoint adds an item to the schedule of the target proposal.
The request body is a dictionary of field-name/value pairs. The system automatically sets the ProposalID and MemberID fields from the proposal, so callers do not need to include them.
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 insert a location:
POST /api/Quotes/Proposals/12345/Schedules/ProposalLocation
Content-Type: application/json
{
"LocationName": "Branch Office",
"Address1": "789 Oak Ave",
"City": "Springfield",
"StateCode": "IL",
"ZipCode": "62701"
}{
"IsSuccessful": true,
"RecordID": 102,
"OrderNumber": null,
"Message": "Inserted schedule with id 102 successfully.",
"Warnings": null
}Scenario 2: Validation fails (required field missing):
POST /api/Quotes/Proposals/12345/Schedules/ProposalLocation
Content-Type: application/json
{
"Address1": "789 Oak Ave"
}{
"IsSuccessful": false,
"RecordID": 0,
"OrderNumber": null,
"Message": "LocationName is required.",
"Warnings": null
}Scenario 3: Proposal is not modifiable:
POST /api/Quotes/Proposals/12345/Schedules/ProposalLocation
Content-Type: application/json
{
"LocationName": "Branch Office"
}{
"IsSuccessful": false,
"RecordID": 0,
"OrderNumber": null,
"Message": "Cannot modify Proposal with ID# 12345.",
"Warnings": null
}