POST Draft/Notices/Import

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

This operation is to be used to upload multiple notices, including award information and additional data where relevant. Note that the operation may be used to upload notices with award information, but cannot be used to add award details to already existing notices. Similarly, uploaded notices may include additional data, but additional cannot be added to already existing notices. This is because the awarded and additional detail information supplied in the import is implicitly associated with an imported notice and there is no means to select a previously imported notice. Where a notice is awarded to multiple suppliers, this is indicated by providing multiple AwardDetail items. Note that only supplier-specific information should vary between AwardDetail items - award-level information will be set by the first item only: i.e. Value, Start Date, End Date, Awarded Date, Procedure Type, Annex D Option Type, and Reason Contract Lawful.

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 to be imported.

Collection of ImportNotice

Name	Description	Type	Additional information
Notice	A NoticeImport object containing the core details of the notice.	NoticeImport	None.
Awards	A collection of AwardDetailImport objects describing any awards associated with this notice.	Collection of AwardDetailImport	None.
IsPublished	A flag indicating that this notice is to be imported in a published state.	boolean	None.
AdditionalDetails	A collection of AdditionalDetailImport objects describing additional details associated with this notice. For example, URL links to relevant information or file attachments.	Collection of AdditionalDetailImport	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:

[
  {
    "notice": {
      "buyingOrganisationName": null,
      "parentIdentifier": null,
      "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.",
      "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"
      ],
      "spendProfile": null,
      "isSuitableForSme": true,
      "isSuitableForVco": false,
      "procedureType": "Open",
      "ojeuContractType": "Works",
      "isFrameworkAgreement": false,
      "isExtensionPossible": false,
      "annexDOption": null,
      "reasonContractLawful": null
    },
    "awards": [
      {
        "value": 5000.0,
        "supplierName": "Supplies Ltd",
        "supplierAddress": "Warehouse 3, Triangle Estate, Reading, RG1 1BB",
        "contact": "Joe Bloggs",
        "dunsNumber": "987654321",
        "startDate": "2015-06-01T00:00:00",
        "endDate": "2015-09-01T00:00:00",
        "awardedDate": "2015-03-01T00:00:00",
        "awardedProcedureType": "Open",
        "annexDOptionType": null,
        "reasonContractLawful": null
      },
      {
        "value": 5000.0,
        "supplierName": "Works Ltd",
        "supplierAddress": "Warehouse 7, Circle Street, Bolton, BL3 1BB",
        "contact": "Jane Smith",
        "dunsNumber": "123456789",
        "startDate": "2015-06-01T00:00:00",
        "endDate": "2015-09-01T00:00:00",
        "awardedDate": "2015-03-01T00:00:00",
        "awardedProcedureType": "Open",
        "annexDOptionType": null,
        "reasonContractLawful": null
      }
    ],
    "isPublished": false,
    "additionalDetails": [
      {
        "description": null,
        "dataType": "AdditionalText",
        "textData": "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.",
        "link": null
      }
    ],
    "withdrawnDate": null,
    "withdrawnReason": null
  },
  {
    "notice": {
      "buyingOrganisationName": null,
      "parentIdentifier": null,
      "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.",
      "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"
      ],
      "spendProfile": null,
      "isSuitableForSme": true,
      "isSuitableForVco": false,
      "procedureType": "Open",
      "ojeuContractType": "Works",
      "isFrameworkAgreement": false,
      "isExtensionPossible": false,
      "annexDOption": null,
      "reasonContractLawful": null
    },
    "awards": [
      {
        "value": 5000.0,
        "supplierName": "Supplies Ltd",
        "supplierAddress": "Warehouse 3, Triangle Estate, Reading, RG1 1BB",
        "contact": "Joe Bloggs",
        "dunsNumber": "987654321",
        "startDate": "2015-06-01T00:00:00",
        "endDate": "2015-09-01T00:00:00",
        "awardedDate": "2015-03-01T00:00:00",
        "awardedProcedureType": "Open",
        "annexDOptionType": null,
        "reasonContractLawful": null
      },
      {
        "value": 5000.0,
        "supplierName": "Works Ltd",
        "supplierAddress": "Warehouse 7, Circle Street, Bolton, BL3 1BB",
        "contact": "Jane Smith",
        "dunsNumber": "123456789",
        "startDate": "2015-06-01T00:00:00",
        "endDate": "2015-09-01T00:00:00",
        "awardedDate": "2015-03-01T00:00:00",
        "awardedProcedureType": "Open",
        "annexDOptionType": null,
        "reasonContractLawful": null
      }
    ],
    "isPublished": false,
    "additionalDetails": [
      {
        "description": null,
        "dataType": "AdditionalText",
        "textData": "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.",
        "link": null
      }
    ],
    "withdrawnDate": null,
    "withdrawnReason": null
  }
]

application/xml, text/xml

Sample:

<ArrayOfImportNotice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IPL.ContractsFinder.BusinessEntities.Import">
  <ImportNotice>
    <AdditionalDetails>
      <AdditionalDetailImport>
        <DataType>AdditionalText</DataType>
        <Description i:nil="true" />
        <Link i:nil="true" />
        <TextData>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.</TextData>
      </AdditionalDetailImport>
    </AdditionalDetails>
    <Awards>
      <AwardDetailImport>
        <AnnexDOptionType i:nil="true" />
        <AwardedDate>2015-03-01T00:00:00</AwardedDate>
        <AwardedProcedureType>Open</AwardedProcedureType>
        <Contact>Joe Bloggs</Contact>
        <DunsNumber>987654321</DunsNumber>
        <EndDate>2015-09-01T00:00:00</EndDate>
        <ReasonContractLawful i:nil="true" />
        <StartDate>2015-06-01T00:00:00</StartDate>
        <SupplierAddress>Warehouse 3, Triangle Estate, Reading, RG1 1BB</SupplierAddress>
        <SupplierName>Supplies Ltd</SupplierName>
        <Value>5000.0</Value>
      </AwardDetailImport>
      <AwardDetailImport>
        <AnnexDOptionType i:nil="true" />
        <AwardedDate>2015-03-01T00:00:00</AwardedDate>
        <AwardedProcedureType>Open</AwardedProcedureType>
        <Contact>Jane Smith</Contact>
        <DunsNumber>123456789</DunsNumber>
        <EndDate>2015-09-01T00:00:00</EndDate>
        <ReasonContractLawful i:nil="true" />
        <StartDate>2015-06-01T00:00:00</StartDate>
        <SupplierAddress>Warehouse 7, Circle Street, Bolton, BL3 1BB</SupplierAddress>
        <SupplierName>Works Ltd</SupplierName>
        <Value>5000.0</Value>
      </AwardDetailImport>
    </Awards>
    <IsPublished>false</IsPublished>
    <Notice>
      <AnnexDOption i:nil="true" />
      <ApproachMarketDate i:nil="true" />
      <BuyingOrganisationName 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:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>44618420</d4p1:string>
        <d4p1:string>51542000</d4p1: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>
      <Identifier>OPP0001-A</Identifier>
      <IsExtensionPossible>false</IsExtensionPossible>
      <IsFrameworkAgreement>false</IsFrameworkAgreement>
      <IsSuitableForSme>true</IsSuitableForSme>
      <IsSuitableForVco>false</IsSuitableForVco>
      <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>
      <SpendProfile 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>
    </Notice>
    <WithdrawnDate i:nil="true" />
    <WithdrawnReason i:nil="true" />
  </ImportNotice>
  <ImportNotice>
    <AdditionalDetails>
      <AdditionalDetailImport>
        <DataType>AdditionalText</DataType>
        <Description i:nil="true" />
        <Link i:nil="true" />
        <TextData>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.</TextData>
      </AdditionalDetailImport>
    </AdditionalDetails>
    <Awards>
      <AwardDetailImport>
        <AnnexDOptionType i:nil="true" />
        <AwardedDate>2015-03-01T00:00:00</AwardedDate>
        <AwardedProcedureType>Open</AwardedProcedureType>
        <Contact>Joe Bloggs</Contact>
        <DunsNumber>987654321</DunsNumber>
        <EndDate>2015-09-01T00:00:00</EndDate>
        <ReasonContractLawful i:nil="true" />
        <StartDate>2015-06-01T00:00:00</StartDate>
        <SupplierAddress>Warehouse 3, Triangle Estate, Reading, RG1 1BB</SupplierAddress>
        <SupplierName>Supplies Ltd</SupplierName>
        <Value>5000.0</Value>
      </AwardDetailImport>
      <AwardDetailImport>
        <AnnexDOptionType i:nil="true" />
        <AwardedDate>2015-03-01T00:00:00</AwardedDate>
        <AwardedProcedureType>Open</AwardedProcedureType>
        <Contact>Jane Smith</Contact>
        <DunsNumber>123456789</DunsNumber>
        <EndDate>2015-09-01T00:00:00</EndDate>
        <ReasonContractLawful i:nil="true" />
        <StartDate>2015-06-01T00:00:00</StartDate>
        <SupplierAddress>Warehouse 7, Circle Street, Bolton, BL3 1BB</SupplierAddress>
        <SupplierName>Works Ltd</SupplierName>
        <Value>5000.0</Value>
      </AwardDetailImport>
    </Awards>
    <IsPublished>false</IsPublished>
    <Notice>
      <AnnexDOption i:nil="true" />
      <ApproachMarketDate i:nil="true" />
      <BuyingOrganisationName 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:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>44618420</d4p1:string>
        <d4p1:string>51542000</d4p1: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>
      <Identifier>OPP0001-A</Identifier>
      <IsExtensionPossible>false</IsExtensionPossible>
      <IsFrameworkAgreement>false</IsFrameworkAgreement>
      <IsSuitableForSme>true</IsSuitableForSme>
      <IsSuitableForVco>false</IsSuitableForVco>
      <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>
      <SpendProfile 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>
    </Notice>
    <WithdrawnDate i:nil="true" />
    <WithdrawnReason i:nil="true" />
  </ImportNotice>
</ArrayOfImportNotice>

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>