GET api/rest/2/get_draft_notice/{MimeType}/{id}
For the Version 1 equivalent method, please visit GET Draft/Notice/{id}. However please note that 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 this Version 2 method.
Gets the draft notice identified by the provided GUID.
Requires Authorization
The endpoint requires a bearer token in the http authorization header. For example "bearer 2YotnFZFEjr1zCsicMWpAA"
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
The identity of the notice to get. |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Returns the requested draft notice if successful; otherwise a collection of validation errors with HTTP status 400.
FullNoticeName | Description | Type | Additional information |
---|---|---|---|
Id |
The GUID uniquely identifying this notice. (Assigned by the system at creation, should only be supplied for subsequent updates and actions). |
globally unique identifier |
None. |
Notice |
A Notice object containing the notice details. |
Notice |
None. |
CreatedByUser |
The username of the intial creator of this notice. |
string |
None. |
CreatedDate |
The date that this notice was created. |
date |
None. |
LastUpdatedByUser |
The username of the last user to edit this notice. (Set internally - ignored for API data uploads). |
string |
None. |
LastUpdatedDate |
The date on which this notice was last edited. (Set internally - ignored for API data uploads). |
date |
None. |
Awards |
A collection of AwardDetail objects describing awards associated with this notice. |
Collection of AwardDetail |
None. |
IsPublished |
A flag indicating whether this notice has been published for public viewing on the Contracts Finder online service. |
boolean |
None. |
IsPreAwarded |
A flag indicating if this notice was created on Contracts Finder in an already awarded state. |
boolean |
None. |
Organisation |
An OrganisationDetails object describing the buying organisation associated with this notice. (Set internally - ignored for API data uploads). |
OrganisationDetails |
None. |
AdditionalDetails |
A list of AdditionalDetail objects describing any additional information or files attached to this notice. |
Collection of AdditionalDetail |
None. |
WithdrawnByUser |
If the notice is withdrawn, the user that actioned the withdrawal. |
string |
None. |
WithdrawnDate |
If the notice is withdrawn, the date of withdrawal. |
date |
None. |
WithdrawnReason |
Reasoning if the notice has been withdrawn. |
string |
None. |
CpvCodes |
A list of CpvCode objects identifying any CPV codes that this notice relates to. |
Collection of CpvCode |
None. |
PublishedVersion |
A list of PublishedNoticeVersion objects describing the version history of this notice. |
Collection of PublishedNoticeVersion |
None. |
NumberOfViews |
The number of times this notice has been viewed through Contracts Finder. |
integer |
None. |
Response Formats
application/json, text/json
{ "id": "d31c1dfb-462c-42f6-ab22-6860cc3a65b0", "notice": { "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:00Z", "approachMarketDate": null, "deadlineDate": "2015-04-01T00:00:00+01: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+01:00", "end": "2015-06-01T00:00:00+01:00", "type": "Contract", "cpvCodes": [ "44618420", "51542000" ], "spendProfile": null, "status": "Open", "isSuitableForSme": true, "isSuitableForVco": false, "supplyChain": false, "lastNotifiableUpdate": "0001-01-01T00:00:00Z", "organisationName": null, "sector": null, "procedureType": "Open", "ojeuContractType": "Works", "isFrameworkAgreement": false, "isExtensionPossible": false, "annexDOption": null, "reasonContractLawful": null }, "createdByUser": "a.buyer@dept.gov.uk", "createdDate": "2015-01-01T00:00:00Z", "lastUpdatedByUser": "a.buyer@dept.gov.uk", "lastUpdatedDate": "2015-02-01T00:00:00Z", "awards": [ { "id": 1, "noticeId": "2e3ee6d0-593a-4077-96ce-4632caf5cff5", "parentId": null, "value": 5000.0, "supplierName": "Supplies Ltd", "supplierAddress": "Warehouse 3, Triangle Estate, Reading, RG1 1BB", "contact": "Joe Bloggs", "dunsNumber": "987654321", "referenceType": "COMPANIES_HOUSE", "reference": "123456789", "supplierAwardedValue": 100.0, "startDate": "2015-06-01T00:00:00+01:00", "endDate": "2015-09-01T00:00:00+01:00", "awardedDate": "2015-03-01T00:00:00Z", "awardedProcedureType": "Open", "annexDOptionType": null, "reasonContractLawful": null, "additionalDetails": null, "awardedToSME": false, "awardedToVCSO": false, "awardGuid": null } ], "isPublished": true, "isPreAwarded": true, "organisation": { "name": "BuyingOrg" }, "additionalDetails": [ { "id": "e18c23be-0293-4f76-817c-1dcda84ebe42", "noticeId": "d31c1dfb-462c-42f6-ab22-6860cc3a65b0", "description": "Organisation link", "dataType": "Link", "textData": null, "link": "http://www.org.co.uk/", "mimeType": null, "filename": null, "fileContent": null, "awardGuid": null }, { "id": "c3c27b8a-f404-45de-bf62-48c5cdc5e0ec", "noticeId": "d31c1dfb-462c-42f6-ab22-6860cc3a65b0", "description": "Document attachment", "dataType": "Attachment", "textData": null, "link": null, "mimeType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "filename": "Proposal.docx", "fileContent": null, "awardGuid": null }, { "id": "c3c27b8a-f404-45de-bf62-48c5cdc5e0ec", "noticeId": "d31c1dfb-462c-42f6-ab22-6860cc3a65b0", "description": null, "dataType": "Attachment", "textData": null, "link": null, "mimeType": null, "filename": null, "fileContent": null, "awardGuid": null } ], "withdrawnByUser": null, "withdrawnDate": null, "withdrawnReason": null, "cpvCodes": [ { "code": "44618420", "description": "Food cans", "parentCode": "44618000", "hasChildren": false }, { "code": "51542000", "description": "Installation of food-processing machinery", "parentCode": "51540000", "hasChildren": false } ], "publishedVersion": [ { "changedByUser": "a.buyer@dept.gov.uk", "dateChanged": "2015-02-01T00:00:00Z", "id": 1, "noticeStatus": "Open", "noticeType": "Contract", "publishedNoticeId": "d31c1dfb-462c-42f6-ab22-6860cc3a65b0", "versionNumber": 1, "visibleToPublic": true }, { "changedByUser": "a.buyer@dept.gov.uk", "dateChanged": "2015-02-02T00:00:00Z", "id": 2, "noticeStatus": "Open", "noticeType": "Contract", "publishedNoticeId": "d31c1dfb-462c-42f6-ab22-6860cc3a65b0", "versionNumber": 2, "visibleToPublic": true } ], "numberOfViews": 42 }
application/xml, text/xml
<FullNotice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IPL.ContractsFinder.BusinessEntities"> <AdditionalDetails> <AdditionalDetail> <AwardGuid i:nil="true" /> <DataType>Link</DataType> <Description>Organisation link</Description> <FileContent i:nil="true" /> <Filename i:nil="true" /> <Id>e18c23be-0293-4f76-817c-1dcda84ebe42</Id> <Link>http://www.org.co.uk/</Link> <MimeType i:nil="true" /> <NoticeId>d31c1dfb-462c-42f6-ab22-6860cc3a65b0</NoticeId> <TextData i:nil="true" /> </AdditionalDetail> <AdditionalDetail> <AwardGuid i:nil="true" /> <DataType>Attachment</DataType> <Description>Document attachment</Description> <FileContent i:nil="true" /> <Filename>Proposal.docx</Filename> <Id>c3c27b8a-f404-45de-bf62-48c5cdc5e0ec</Id> <Link i:nil="true" /> <MimeType>application/vnd.openxmlformats-officedocument.wordprocessingml.document</MimeType> <NoticeId>d31c1dfb-462c-42f6-ab22-6860cc3a65b0</NoticeId> <TextData i:nil="true" /> </AdditionalDetail> <AdditionalDetail> <AwardGuid i:nil="true" /> <DataType>Attachment</DataType> <Description i:nil="true" /> <FileContent i:nil="true" /> <Filename i:nil="true" /> <Id>c3c27b8a-f404-45de-bf62-48c5cdc5e0ec</Id> <Link i:nil="true" /> <MimeType i:nil="true" /> <NoticeId>d31c1dfb-462c-42f6-ab22-6860cc3a65b0</NoticeId> <TextData i:nil="true" /> </AdditionalDetail> </AdditionalDetails> <Awards> <AwardDetail> <AdditionalDetails i:nil="true" /> <AnnexDOptionType i:nil="true" /> <AwardGuid i:nil="true" /> <AwardedDate>2015-03-01T00:00:00Z</AwardedDate> <AwardedProcedureType>Open</AwardedProcedureType> <AwardedToSME>false</AwardedToSME> <AwardedToVCSO>false</AwardedToVCSO> <Contact>Joe Bloggs</Contact> <DunsNumber>987654321</DunsNumber> <EndDate>2015-09-01T00:00:00+01:00</EndDate> <Id>1</Id> <NoticeId>2e3ee6d0-593a-4077-96ce-4632caf5cff5</NoticeId> <ParentId i:nil="true" /> <ReasonContractLawful i:nil="true" /> <StartDate>2015-06-01T00:00:00+01:00</StartDate> <SupplierAddress>Warehouse 3, Triangle Estate, Reading, RG1 1BB</SupplierAddress> <SupplierName>Supplies Ltd</SupplierName> <Value>5000.0</Value> <ReferenceType>COMPANIES_HOUSE</ReferenceType> <Reference>123456789</Reference> <SupplierAwardedValue>100.0</SupplierAwardedValue> </AwardDetail> </Awards> <CpvCodes> <CpvCode> <Code>44618420</Code> <Description>Food cans</Description> <HasChildren>false</HasChildren> <ParentCode>44618000</ParentCode> </CpvCode> <CpvCode> <Code>51542000</Code> <Description>Installation of food-processing machinery</Description> <HasChildren>false</HasChildren> <ParentCode>51540000</ParentCode> </CpvCode> </CpvCodes> <CreatedByUser>a.buyer@dept.gov.uk</CreatedByUser> <CreatedDate>2015-01-01T00:00:00Z</CreatedDate> <Id>d31c1dfb-462c-42f6-ab22-6860cc3a65b0</Id> <IsPreAwarded>true</IsPreAwarded> <IsPublished>true</IsPublished> <LastUpdatedByUser>a.buyer@dept.gov.uk</LastUpdatedByUser> <LastUpdatedDate>2015-02-01T00:00:00Z</LastUpdatedDate> <Notice> <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:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>44618420</d3p1:string> <d3p1:string>51542000</d3p1:string> </CpvCodes> <DeadlineDate>2015-04-01T00:00:00+01: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+01: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> <SupplyChain>false</SupplyChain> <LastNotifiableUpdate>0001-01-01T00:00:00Z</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:00Z</PublishedDate> <ReasonContractLawful i:nil="true" /> <Region>Wales,London</Region> <Sector i:nil="true" /> <SpendProfile i:nil="true" /> <Start>2015-05-01T00:00:00+01:00</Start> <Status>Open</Status> <Title>Leaflet production and distribution</Title> <Type>Contract</Type> <ValueHigh>15000.0</ValueHigh> <ValueLow>5000.0</ValueLow> </Notice> <NumberOfViews>42</NumberOfViews> <Organisation> <Name>BuyingOrg</Name> </Organisation> <PublishedVersion> <PublishedNoticeVersion> <ChangedByUser>a.buyer@dept.gov.uk</ChangedByUser> <DateChanged>2015-02-01T00:00:00Z</DateChanged> <Id>1</Id> <NoticeStatus>Open</NoticeStatus> <NoticeType>Contract</NoticeType> <PublishedNoticeId>d31c1dfb-462c-42f6-ab22-6860cc3a65b0</PublishedNoticeId> <VersionNumber>1</VersionNumber> <VisibleToPublic>true</VisibleToPublic> </PublishedNoticeVersion> <PublishedNoticeVersion> <ChangedByUser>a.buyer@dept.gov.uk</ChangedByUser> <DateChanged>2015-02-02T00:00:00Z</DateChanged> <Id>2</Id> <NoticeStatus>Open</NoticeStatus> <NoticeType>Contract</NoticeType> <PublishedNoticeId>d31c1dfb-462c-42f6-ab22-6860cc3a65b0</PublishedNoticeId> <VersionNumber>2</VersionNumber> <VisibleToPublic>true</VisibleToPublic> </PublishedNoticeVersion> </PublishedVersion> <WithdrawnByUser i:nil="true" /> <WithdrawnDate i:nil="true" /> <WithdrawnReason i:nil="true" /> </FullNotice>