POST Draft/Notice/Validate
This operation is used to simply validate the notice. This is used when validation has already failed after a user has attempted to publish the notice. Needed because we refresh the page if validation fails - losing the error messages.
Requires Authorization
The endpoint requires a bearer token in the http authorization header. For example "bearer 2YotnFZFEjr1zCsicMWpAA"
Request Information
URI Parameters
None.
Body Parameters
The details of the notice to be validated.
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
{
"noticeId": "dd52b362-2a15-4e7d-b047-557da95226ce",
"comment": "Approved and ready to publish",
"visibleToPublic": true
}
application/xml, text/xml
<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 not available.
Response Information
Resource Description
Returns HTTP status 200 if validation is 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
{
"code": "Ok",
"errors": null
}