POST Published/Notice/Withdraw/2
Withdraws the published notice identified by the provided identifier. A reason needs to be provided and is recorded against the withdrawal action.
Requires Authorization
The endpoint requires a bearer token in the http authorization header. For example "bearer 2YotnFZFEjr1zCsicMWpAA"
Request Information
URI Parameters
None.
Body Parameters
Request containing the id of notice to withdraw and the reason for the withdrawal of the notice.
WithdrawNoticeRequestName | Description | Type | Additional information |
---|---|---|---|
NoticeId |
Gets or sets the Notice . |
globally unique identifier |
None. |
WithdrawalReason |
Gets or sets the withdrawal reason for the request. |
string |
None. |
Request Formats
application/json, text/json
Sample:
{ "noticeId": "58e936c8-2f35-4fa6-aac5-178f5d337aef", "withdrawalReason": "Opportunity gone away" }
application/xml, text/xml
Sample:
<WithdrawNoticeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IPL.ContractsFinder.WebApi.Shared.Models"> <NoticeId>58e936c8-2f35-4fa6-aac5-178f5d337aef</NoticeId> <WithdrawalReason>Opportunity gone away</WithdrawalReason> </WithdrawNoticeRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Returns a HTTP status code of 200 if successful; otherwise a collection of validation errors with HTTP status code 400.
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
{ "code": "Ok", "errors": null, "noticeId": "71fdd817-88af-4161-9a15-7cc2d107c6aa" }
application/xml, text/xml
Sample:
<WithdrawNoticeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Code>Ok</Code> <Error></Error> <NoticeId>58e936c8-2f35-4fa6-aac5-178f5d337aef</NoticeId> </WithdrawNoticeResponse>