POST Draft/Notice/Publish

This Version 1 API method is deprecated.
Whilst we are still supporting Version 1 methods for the foreseeable future to provide backwards compatibility, they should be considered deprecated and we encourage the use of the Version 2 method, POST api/rest/2/publish_draft_notice/{MimeType}.

This operation allows an existing notice to be published. This will make the current state of the notice visible to the public through the Contracts Finder online service. The publish request may include comments that are recorded against the publish action. If the VisibleToPublic flag is false, notifications will be suppressed to anybody watching this notice - this is only appropriate for minor modifications to existing notices.

Requires Authorization

The endpoint requires a bearer token in the http authorization header. For example "bearer 2YotnFZFEjr1zCsicMWpAA"

Request Information

URI Parameters

None.

Body Parameters

Details of the publish request.

PublishNoticeRequest

Name	Description	Type	Additional information
NoticeId	Gets or sets the Notice .	globally unique identifier	None.
Comment	Gets or sets the comment for Publish User Comment request.	string	None.
VisibleToPublic	Gets or sets a value indicating whether the comment is visible to the public	boolean	No longer used - comments visible to buyer organisation only.

Request Formats

application/json, text/json

Sample:

{
  "noticeId": "dd52b362-2a15-4e7d-b047-557da95226ce",
  "comment": "Approved and ready to publish",
  "visibleToPublic": true
}

application/xml, text/xml

Sample:

<PublishNoticeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IPL.ContractsFinder.WebApi.Shared.Models">
  <Comment>Approved and ready to publish</Comment>
  <NoticeId>dd52b362-2a15-4e7d-b047-557da95226ce</NoticeId>
  <VisibleToPublic>true</VisibleToPublic>
</PublishNoticeRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns HTTP status 200 if successful; otherwise a collection of errors with HTTP status 400.

ServiceResponse

Name	Description	Type	Additional information
Code		ServiceResponseCode	None.
Errors		Collection of Error	None.

Response Formats

application/json, text/json

Sample:

{
  "code": "Ok",
  "errors": null
}