POST api/progression/lettings/withdrawInstruction

Withdraw a letting at the end of let Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

The withdraw letting instruction command data contract supplied with the request.

WithdrawLettingInstructionCommandDataContract

Name	Description	Type	Additional information
EndDate	The end date, expressed as a date and time.	date	None.
WithdrawnInstructionReasonType	The withdrawn instruction reason type value.	EnumDataContract	None.
NegotiatorIds	The unique identifiers of the related negotiator resources.	Collection of integer	None.
RoleId	The unique identifier of the related role resource.	integer	None.
Notes	The notes value.	string	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "EndDate": "2026-08-05T01:30:52.9472199Z",
  "WithdrawnInstructionReasonType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "NegotiatorIds": [
    1,
    2
  ],
  "RoleId": 1,
  "Notes": "sample string 2"
}

Response Information

Resource Description

The response returned after the operation completes.

HttpResponseMessage

Name	Description	Type	Additional information
Version	The version value.	Version	None.
Content	The content value.	HttpContent	None.
StatusCode	The status code classification.	HttpStatusCode	None.
ReasonPhrase	The reason phrase value.	string	None.
Headers	The collection of headers.	Collection of Object	None.
RequestMessage	The request message value.	HttpRequestMessage	None.
IsSuccessStatusCode	Indicates whether this item is success status code.	boolean	None.