POST Draft/Notices/ImportFlat

This operation provides the same functionality as Draft/Notices/Import. However, the input format for this variant is simpler in structure, but is more restrictive.

Requires Authorization

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

Request Information

URI Parameters

None.

Body Parameters

A collection of ImportNotice objects describing the notices to import.

Collection of ImportNoticeFlat

Name	Description	Type	Additional information
ParentIdentifier	The user-defined identifier of the parent notice, where relevant. This applies when this notice represents a sub-contract.	string	Max length: 100
Identifier	The user-supplied identifier for the notice. This must be unique within the organisation associated with the notice.	string	Max length: 100
Title	The title for this opportunity.	string	Max length: 300
Description	A full description of the opportunity.	string	Max length: 3000
ApproachMarketDate	The Approach to Market Date where applicable. This applies to Future Opportunity (Pipeline) notices.	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 value range of this contract in GBP.	decimal number	None.
ValueHigh	The upper end of the value range of this contract in GBP.	decimal number	None.
Postcode	A postcode identifying the geographic location of the opportunity.	string	None.
Region	A region or list of regions identifying the geographic location of the opportunity.	string	None.
Nationwide	A flag indicating if the opportunity applies nationwide.	boolean	None.
Start	The start date for the contract.	date	None.
End	The end date for the contract.	date	None.
Type	The notice type.	NoticeTypeImport	None.
CpvCodes	A comma-separated list of CPV codes related to this notice.	string	None.
SpendProfileYears	Comma separated list of Spend Profile Years. The number of items in SpendProfileYears and SpendProfileAmounts nust match.	string	None.
SpendProfileAmounts	Comma separated list of Spend Profile Amounts. The number of items in SpendProfileYears and SpendProfileAmounts nust match.	string	None.
IsSuitableForSme	A flag indicating whether this contract is suitable for SMEs.	boolean	None.
IsSuitableForVco	A flag indicating whether this contract is suitable for VCOs.	boolean	None.
ProcedureType	The Procedure Type for the contract.	ProcedureTypeImport	None.
ProcedureTypeOther	Gets or sets the other procedure detail	String	None.
ProcedureAcceleratedJustification	Gets or sets justification of accelerated procedure	String	None.
OjeuContractType	The Contract Type.	OjeuContractTypeImport	None.
IsFrameworkAgreement	A flag indicating that this is a framework agreement.	boolean	None.
IsExtensionPossible	A flag indicating that extensions are possible.	boolean	None.
AnnexDOption	The Annex D option, where applicable.	string	None.
ReasonContractLawful	The reason this contract is lawful, where applicable.	string	None.
ContactName	A contact name.	string	None.
ContactEmail	A contact e-mail address.	string	None.
ContactAddress1	Line 1 of a postal address.	string	None.
ContactAddress2	Line 2 of a postal address.	string	None.
ContactTown	The postal town.	string	None.
ContactPostcode	The contact postcode.	string	None.
ContactCountry	The country of the address.	string	None.
ContactPhone	A contact telephone number.	string	None.
ContactWebAddress	A website address for the contact.	string	None.
AwardValue	The value of the award.	decimal number	None.
AwardSupplierName	The awarded supplier name.	string	None.
AwardSupplierAddress	The awarded supplier address.	string	None.
AwardContact	Contact name for the supplier.	string	None.
AwardDunsNumber	The awarded supplier DUNS number.	string	None.
AwardStartDate	The contract start date.	date	None.
AwardEndDate	The contract end date.	date	None.
AwardAwardedDate	The awarded date.	date	None.
AwardedProcedureType	The procedure type.	AwardedProcedureTypeImport	None.
AwardedProcedureTypeOther	Gets or sets the other procedure detail	String	None.
AwardedProcedureAcceleratedJustification	Gets or sets justification of accelerated procedure	String	None.
AwardAnnexDOptionType	The Annex D option type.	AnnexDOptionTypeImport	None.
AwardReasonContractLawful	The lawful reason.	string	None.
AdditionalText	Additional text.	string	None.
Link1	The first link.	string	None.
Link1Description	A description of the first link.	string	None.
Link2	The second link.	string	None.
Link2Description	A description of the second link.	string	None.
Link3	The third link.	string	None.
Link3Description	A description of the third link.	string	None.
IsPublished	A flag indicating that this notice is to be imported in a published state.	boolean	None.
WithdrawnDate	The date that this notice was withdrawn, if applicable.	date	None.
WithdrawnReason	The reason that this notice was withdrawn, if applicable.	string	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "parentIdentifier": null,
    "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.",
    "approachMarketDate": null,
    "deadlineDate": "2015-04-01T00:00:00",
    "valueLow": 5000.0,
    "valueHigh": 15000.0,
    "postcode": null,
    "region": "Wales,London",
    "nationwide": null,
    "start": "2015-05-01T00:00:00",
    "end": "2015-06-01T00:00:00",
    "type": "Contract",
    "cpvCodes": "44618420,51542000",
    "spendProfileYears": null,
    "spendProfileAmounts": null,
    "isSuitableForSme": true,
    "isSuitableForVco": false,
    "procedureType": "Open",
    "ojeuContractType": "Works",
    "isFrameworkAgreement": false,
    "isExtensionPossible": false,
    "annexDOption": null,
    "reasonContractLawful": null,
    "contactName": "Mrs Jane Doe",
    "contactEmail": "j.doe@janedoesite.co.uk",
    "contactAddress1": "1 Dermant Street",
    "contactAddress2": "Frixton",
    "contactTown": "Anborough",
    "contactPostcode": "AX1 1PP",
    "contactCountry": "UK",
    "contactPhone": "07777 123456",
    "contactWebAddress": "www.janedoesite.co.uk",
    "awardValue": 5000.0,
    "awardSupplierName": "Supplies Ltd",
    "awardSupplierAddress": "Warehouse 3, Triangle Estate, Reading, RG1 1BB",
    "awardContact": "Joe Bloggs",
    "awardDunsNumber": "987654321",
    "awardStartDate": "2015-06-01T00:00:00",
    "awardEndDate": "2015-09-01T00:00:00",
    "awardAwardedDate": "2015-03-01T00:00:00",
    "awardedProcedureType": "Open",
    "awardAnnexDOptionType": null,
    "awardReasonContractLawful": null,
    "additionalText": "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.",
    "link1": null,
    "link1Description": null,
    "link2": null,
    "link2Description": null,
    "link3": null,
    "link3Description": null,
    "isPublished": false,
    "withdrawnDate": null,
    "withdrawnReason": null
  },
  {
    "parentIdentifier": null,
    "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.",
    "approachMarketDate": null,
    "deadlineDate": "2015-04-01T00:00:00",
    "valueLow": 5000.0,
    "valueHigh": 15000.0,
    "postcode": null,
    "region": "Wales,London",
    "nationwide": null,
    "start": "2015-05-01T00:00:00",
    "end": "2015-06-01T00:00:00",
    "type": "Contract",
    "cpvCodes": "44618420,51542000",
    "spendProfileYears": null,
    "spendProfileAmounts": null,
    "isSuitableForSme": true,
    "isSuitableForVco": false,
    "procedureType": "Open",
    "ojeuContractType": "Works",
    "isFrameworkAgreement": false,
    "isExtensionPossible": false,
    "annexDOption": null,
    "reasonContractLawful": null,
    "contactName": "Mrs Jane Doe",
    "contactEmail": "j.doe@janedoesite.co.uk",
    "contactAddress1": "1 Dermant Street",
    "contactAddress2": "Frixton",
    "contactTown": "Anborough",
    "contactPostcode": "AX1 1PP",
    "contactCountry": "UK",
    "contactPhone": "07777 123456",
    "contactWebAddress": "www.janedoesite.co.uk",
    "awardValue": 5000.0,
    "awardSupplierName": "Supplies Ltd",
    "awardSupplierAddress": "Warehouse 3, Triangle Estate, Reading, RG1 1BB",
    "awardContact": "Joe Bloggs",
    "awardDunsNumber": "987654321",
    "awardStartDate": "2015-06-01T00:00:00",
    "awardEndDate": "2015-09-01T00:00:00",
    "awardAwardedDate": "2015-03-01T00:00:00",
    "awardedProcedureType": "Open",
    "awardAnnexDOptionType": null,
    "awardReasonContractLawful": null,
    "additionalText": "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.",
    "link1": null,
    "link1Description": null,
    "link2": null,
    "link2Description": null,
    "link3": null,
    "link3Description": null,
    "isPublished": false,
    "withdrawnDate": null,
    "withdrawnReason": null
  }
]

application/xml, text/xml

Sample:

<ArrayOfImportNoticeFlat xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IPL.ContractsFinder.BusinessEntities.Import">
  <ImportNoticeFlat>
    <AdditionalText>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.</AdditionalText>
    <AnnexDOption i:nil="true" />
    <ApproachMarketDate i:nil="true" />
    <AwardAnnexDOptionType i:nil="true" />
    <AwardAwardedDate>2015-03-01T00:00:00</AwardAwardedDate>
    <AwardContact>Joe Bloggs</AwardContact>
    <AwardDunsNumber>987654321</AwardDunsNumber>
    <AwardEndDate>2015-09-01T00:00:00</AwardEndDate>
    <AwardReasonContractLawful i:nil="true" />
    <AwardStartDate>2015-06-01T00:00:00</AwardStartDate>
    <AwardSupplierAddress>Warehouse 3, Triangle Estate, Reading, RG1 1BB</AwardSupplierAddress>
    <AwardSupplierName>Supplies Ltd</AwardSupplierName>
    <AwardValue>5000.0</AwardValue>
    <AwardedProcedureType>Open</AwardedProcedureType>
    <ContactAddress1>1 Dermant Street</ContactAddress1>
    <ContactAddress2>Frixton</ContactAddress2>
    <ContactCountry>UK</ContactCountry>
    <ContactEmail>j.doe@janedoesite.co.uk</ContactEmail>
    <ContactName>Mrs Jane Doe</ContactName>
    <ContactPhone>07777 123456</ContactPhone>
    <ContactPostcode>AX1 1PP</ContactPostcode>
    <ContactTown>Anborough</ContactTown>
    <ContactWebAddress>www.janedoesite.co.uk</ContactWebAddress>
    <CpvCodes>44618420,51542000</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>
    <Identifier>OPP0001-A</Identifier>
    <IsExtensionPossible>false</IsExtensionPossible>
    <IsFrameworkAgreement>false</IsFrameworkAgreement>
    <IsPublished>false</IsPublished>
    <IsSuitableForSme>true</IsSuitableForSme>
    <IsSuitableForVco>false</IsSuitableForVco>
    <Link1 i:nil="true" />
    <Link1Description i:nil="true" />
    <Link2 i:nil="true" />
    <Link2Description i:nil="true" />
    <Link3 i:nil="true" />
    <Link3Description i:nil="true" />
    <Nationwide i:nil="true" />
    <OjeuContractType>Works</OjeuContractType>
    <ParentIdentifier i:nil="true" />
    <Postcode i:nil="true" />
    <ProcedureType>Open</ProcedureType>
    <ReasonContractLawful i:nil="true" />
    <Region>Wales,London</Region>
    <SpendProfileAmounts i:nil="true" />
    <SpendProfileYears i:nil="true" />
    <Start>2015-05-01T00:00:00</Start>
    <Title>Leaflet production and distribution</Title>
    <Type>Contract</Type>
    <ValueHigh>15000.0</ValueHigh>
    <ValueLow>5000.0</ValueLow>
    <WithdrawnDate i:nil="true" />
    <WithdrawnReason i:nil="true" />
  </ImportNoticeFlat>
  <ImportNoticeFlat>
    <AdditionalText>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.</AdditionalText>
    <AnnexDOption i:nil="true" />
    <ApproachMarketDate i:nil="true" />
    <AwardAnnexDOptionType i:nil="true" />
    <AwardAwardedDate>2015-03-01T00:00:00</AwardAwardedDate>
    <AwardContact>Joe Bloggs</AwardContact>
    <AwardDunsNumber>987654321</AwardDunsNumber>
    <AwardEndDate>2015-09-01T00:00:00</AwardEndDate>
    <AwardReasonContractLawful i:nil="true" />
    <AwardStartDate>2015-06-01T00:00:00</AwardStartDate>
    <AwardSupplierAddress>Warehouse 3, Triangle Estate, Reading, RG1 1BB</AwardSupplierAddress>
    <AwardSupplierName>Supplies Ltd</AwardSupplierName>
    <AwardValue>5000.0</AwardValue>
    <AwardedProcedureType>Open</AwardedProcedureType>
    <ContactAddress1>1 Dermant Street</ContactAddress1>
    <ContactAddress2>Frixton</ContactAddress2>
    <ContactCountry>UK</ContactCountry>
    <ContactEmail>j.doe@janedoesite.co.uk</ContactEmail>
    <ContactName>Mrs Jane Doe</ContactName>
    <ContactPhone>07777 123456</ContactPhone>
    <ContactPostcode>AX1 1PP</ContactPostcode>
    <ContactTown>Anborough</ContactTown>
    <ContactWebAddress>www.janedoesite.co.uk</ContactWebAddress>
    <CpvCodes>44618420,51542000</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>
    <Identifier>OPP0001-A</Identifier>
    <IsExtensionPossible>false</IsExtensionPossible>
    <IsFrameworkAgreement>false</IsFrameworkAgreement>
    <IsPublished>false</IsPublished>
    <IsSuitableForSme>true</IsSuitableForSme>
    <IsSuitableForVco>false</IsSuitableForVco>
    <Link1 i:nil="true" />
    <Link1Description i:nil="true" />
    <Link2 i:nil="true" />
    <Link2Description i:nil="true" />
    <Link3 i:nil="true" />
    <Link3Description i:nil="true" />
    <Nationwide i:nil="true" />
    <OjeuContractType>Works</OjeuContractType>
    <ParentIdentifier i:nil="true" />
    <Postcode i:nil="true" />
    <ProcedureType>Open</ProcedureType>
    <ReasonContractLawful i:nil="true" />
    <Region>Wales,London</Region>
    <SpendProfileAmounts i:nil="true" />
    <SpendProfileYears i:nil="true" />
    <Start>2015-05-01T00:00:00</Start>
    <Title>Leaflet production and distribution</Title>
    <Type>Contract</Type>
    <ValueHigh>15000.0</ValueHigh>
    <ValueLow>5000.0</ValueLow>
    <WithdrawnDate i:nil="true" />
    <WithdrawnReason i:nil="true" />
  </ImportNoticeFlat>
</ArrayOfImportNoticeFlat>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A collection of ImportResult objects describing the outcome.

Collection of ImportResult

Name	Description	Type	Additional information
NoticeIdentifier	The reference of the imported notice	string	None.
NoticeId	The GUID id of the imported notice	globally unique identifier	None.
Result	Describes the import outcome.	ImportResultEnum	None.
Messages	A list of messages	Collection of string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "noticeIdentifier": "OPP0001-A",
    "noticeId": "d31c1dfb-462c-42f6-ab22-6860cc3a65b0",
    "result": "CreatedAsDraft",
    "messages": []
  },
  {
    "noticeIdentifier": "OPP0001-A",
    "noticeId": "d31c1dfb-462c-42f6-ab22-6860cc3a65b0",
    "result": "CreatedAsDraft",
    "messages": []
  }
]

application/xml, text/xml

Sample:

<ArrayOfImportResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IPL.ContractsFinder.BusinessEntities">
  <ImportResult>
    <Messages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
    <NoticeId>d31c1dfb-462c-42f6-ab22-6860cc3a65b0</NoticeId>
    <NoticeIdentifier>OPP0001-A</NoticeIdentifier>
    <Result>CreatedAsDraft</Result>
  </ImportResult>
  <ImportResult>
    <Messages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
    <NoticeId>d31c1dfb-462c-42f6-ab22-6860cc3a65b0</NoticeId>
    <NoticeIdentifier>OPP0001-A</NoticeIdentifier>
    <Result>CreatedAsDraft</Result>
  </ImportResult>
</ArrayOfImportResult>