POST Draft/Notice/Add?isPreAwarded={isPreAwarded}

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/create_draft_notice/{MimeType}.

This operation is used to upload an individual notice. The payload consists of a single notice definition, configured to be an Early Engagement, a Future Opportunity, or a Live Opportunity. Notices can be created "pre-awarded", allowing Award information to be added prior to publishing.

Requires Authorization

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

Request Information

URI Parameters

NameDescriptionTypeAdditional information
isPreAwarded

Indicates if the notice is a pre-awarded notice.

boolean

Required

Body Parameters

The draft notice to add.

Notice
NameDescriptionTypeAdditional information
Id

The GUID uniquely identifying this notice. (Assigned by the system at creation, should only be supplied for subsequent updates and actions).

string

None.

ParentId

Gets or sets our unique id of the parent contract (guid)

string

None.

ParentIdentifier

The identifier of the parent notice if this is notice represents a sub-contract.

string

Max length: 100

LinkReason

The reason for linking the current contract to another.

string

Max length: 1000

Version

Read only. The version of the model being used.

integer

None.

ContactDetails

A ContactDetails object containing contact details associated with the creator of this notice.

ContactDetails

None.

Identifier

The unique identifier for this notice specified by the creator of the notice. (As opposed to the Id, which is internally assigned by Contracts Finder).

string

Max length: 100

Title

The title for this notice.

string

Max length: 300

Description

A full description of the notice. Note that line-breaks can be included as a CR/LF pair. (In JSON this is encoded as "\r\n", and in XML as "
").

string

Max length: 3000

CPVDescription

A description of the CPV codes associated with this notice. (Set internally - ignored for API data uploads).

string

None.

PublishedDate

The date that this notice was published.

date

None.

ApproachMarketDate

The Approach to Market Date, for Future Opportunity (Pipeline) notices only.

date

None.

DeadlineDate

The closing date and time for this opportunity.

date-time

Time part valid for notices published from 1 Aug 2020.

ValueLow

The lower end of the possible value range for this contract.

decimal number

None.

ValueHigh

The upper end of the possible value range for this contract.

decimal number

None.

Postcode

A postcode identifying the geographic location of this opportunity.

string

None.

Region

A region or list of regions identifying the geographic location of this opportunity.

string

None.

Nationwide

A flag indicating if this opportunity applies nationwide. (Set internally - ignored for API data uploads).

boolean

None.

Location

A GeoLocation object identifying the geographic location of this opportunity. (Set internally - ignored for API data uploads).

GeoLocation

None.

Start

The start date for this contract.

date

None.

End

The end date for this contract.

date

None.

Type

The type of contract this notice relates to.

NoticeType

None.

CpvCodes

A list of CPV codes related to this notice.

Collection of string

None.

SpendProfile

For Future Opportunities, a spending profile that divides the value between financial years.

Collection of SpendProfile

None.

Status

The current notice status. (Set internally - ignored for API data uploads).

NoticeStatus

None.

IsSuitableForSme

Gets or sets a value indicating whether the opportunity is suitable for small suppliers

boolean

None.

IsSuitableForVco

Gets or sets a value indicating whether it is suitable for VCO

boolean

None.

LastNotifiableUpdate

Gets or sets the last-notifiable-update date (Set internally - ignored for API data uploads).

date

None.

OrganisationName

Gets or sets the organisation name.

string

None.

Sector

Gets or sets the Sector name. (Set internally - ignored for API data uploads).

string

None.

ProcedureType

Gets or sets the OJEU procedure type.

ProcedureType

None.

ProcedureTypeOther

Gets or sets the other procedure detail

String

None.

ProcedureAcceleratedJustification

Gets or sets justification of accelerated procedure

String

None.

OjeuContractType

Gets or sets the OJEU contract type.

OjeuContractType

None.

IsFrameworkAgreement

Gets or sets a value indicating whether this is a framework agreement.

boolean

None.

IsExtensionPossible

Gets or sets a value indicating whether an extension is possible.

boolean

None.

AnnexDOption

Gets or sets a value indicating an AnnexD option.

string

None.

ReasonContractLawful

Gets or sets a value indicating why a contract is lawful.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "id": "d31c1dfb-462c-42f6-ab22-6860cc3a65b0",
  "parentId": null,
  "parentIdentifier": null,
  "linkReason": null,
  "version": 1,
  "contactDetails": {
    "name": "Mrs Jane Doe",
    "email": "j.doe@janedoesite.co.uk",
    "address1": "1 Dermant Street",
    "address2": "Frixton",
    "town": "Anborough",
    "postcode": "AX1 1PP",
    "country": "UK",
    "phone": "07777 123456",
    "webAddress": "www.janedoesite.co.uk"
  },
  "identifier": "OPP0001-A",
  "title": "Leaflet production and distribution",
  "description": "Lorem ipsum dolor sit amet, debet melius assentior an eos, justo accommodare te vis, in sit solet consequat. No tantas causae qui, melius expetendis id pro.",
  "cpvDescription": null,
  "publishedDate": "0001-01-01T00:00:00",
  "approachMarketDate": null,
  "deadlineDate": "2015-04-01T00:00:00",
  "valueLow": 5000.0,
  "valueHigh": 15000.0,
  "postcode": null,
  "region": "Wales,London",
  "nationwide": null,
  "location": {
    "lat": 0.0,
    "lon": 0.0
  },
  "start": "2015-05-01T00:00:00",
  "end": "2015-06-01T00:00:00",
  "type": "Contract",
  "cpvCodes": [
    "44618420",
    "51542000"
  ],
  "spendProfile": null,
  "status": "Open",
  "isSuitableForSme": true,
  "isSuitableForVco": false,
  "lastNotifiableUpdate": "0001-01-01T00:00:00",
  "organisationName": null,
  "sector": null,
  "procedureType": "Open",
  "ojeuContractType": "Works",
  "isFrameworkAgreement": false,
  "isExtensionPossible": false,
  "annexDOption": null,
  "reasonContractLawful": null
}

application/xml, text/xml

Sample:
<Notice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IPL.ContractsFinder.BusinessEntities">
  <AnnexDOption i:nil="true" />
  <ApproachMarketDate i:nil="true" />
  <CPVDescription i:nil="true" />
  <ContactDetails>
    <Address1>1 Dermant Street</Address1>
    <Address2>Frixton</Address2>
    <Country>UK</Country>
    <Email>j.doe@janedoesite.co.uk</Email>
    <Name>Mrs Jane Doe</Name>
    <Phone>07777 123456</Phone>
    <Postcode>AX1 1PP</Postcode>
    <Town>Anborough</Town>
    <WebAddress>www.janedoesite.co.uk</WebAddress>
  </ContactDetails>
  <CpvCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>44618420</d2p1:string>
    <d2p1:string>51542000</d2p1:string>
  </CpvCodes>
  <DeadlineDate>2015-04-01T00:00:00</DeadlineDate>
  <Description>Lorem ipsum dolor sit amet, debet melius assentior an eos, justo accommodare te vis, in sit solet consequat. No tantas causae qui, melius expetendis id pro.</Description>
  <End>2015-06-01T00:00:00</End>
  <Id>d31c1dfb-462c-42f6-ab22-6860cc3a65b0</Id>
  <Identifier>OPP0001-A</Identifier>
  <IsExtensionPossible>false</IsExtensionPossible>
  <IsFrameworkAgreement>false</IsFrameworkAgreement>
  <IsSuitableForSme>true</IsSuitableForSme>
  <IsSuitableForVco>false</IsSuitableForVco>
  <LastNotifiableUpdate>0001-01-01T00:00:00</LastNotifiableUpdate>
  <LinkReason i:nil="true" />
  <Location>
    <Lat>0</Lat>
    <Lon>0</Lon>
  </Location>
  <Nationwide i:nil="true" />
  <OjeuContractType>Works</OjeuContractType>
  <OrganisationName i:nil="true" />
  <ParentId i:nil="true" />
  <ParentIdentifier i:nil="true" />
  <Postcode i:nil="true" />
  <ProcedureType>Open</ProcedureType>
  <PublishedDate>0001-01-01T00:00:00</PublishedDate>
  <ReasonContractLawful i:nil="true" />
  <Region>Wales,London</Region>
  <Sector i:nil="true" />
  <SpendProfile i:nil="true" />
  <Start>2015-05-01T00:00:00</Start>
  <Status>Open</Status>
  <Title>Leaflet production and distribution</Title>
  <Type>Contract</Type>
  <ValueHigh>15000.0</ValueHigh>
  <ValueLow>5000.0</ValueLow>
</Notice>

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.

globally unique identifier

Response Formats

application/json, text/json

Sample:
"67a077a1-73a4-4be4-9395-440c1e200d13"

application/xml, text/xml

Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">67a077a1-73a4-4be4-9395-440c1e200d13</guid>