POST Searches/Search

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

Searches for notices based on the provided search criteria.

Request Information

URI Parameters

None.

Body Parameters

The search criteria.

NoticeSearchRequest

Name	Description	Type	Additional information
SearchCriteria	Gets or sets the search criteria.	SearchCriteria	None.
Size	Gets or sets the maximum size of the results.	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "searchCriteria": {
    "types": [
      "Contract",
      "Pipeline"
    ],
    "statuses": [
      "Open"
    ],
    "keyword": "Window cleaning",
    "queryString": null,
    "regions": "Wales,South East",
    "postcode": null,
    "radius": 0.0,
    "valueFrom": 3000.0,
    "valueTo": 20000.0,
    "publishedFrom": null,
    "publishedTo": null,
    "deadlineFrom": null,
    "deadlineTo": null,
    "approachMarketFrom": null,
    "approachMarketTo": null,
    "awardedFrom": null,
    "awardedTo": null,
    "isSubcontract": null,
    "suitableForSme": true,
    "suitableForVco": false,
    "cpvCodes": null
  },
  "size": 1000
}

application/xml, text/xml

Sample:

<NoticeSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IPL.ContractsFinder.WebApi.Shared.Models">
  <SearchCriteria xmlns:d2p1="http://schemas.datacontract.org/2004/07/IPL.ContractsFinder.BusinessEntities">
    <d2p1:ApproachMarketFrom i:nil="true" />
    <d2p1:ApproachMarketTo i:nil="true" />
    <d2p1:AwardedFrom i:nil="true" />
    <d2p1:AwardedTo i:nil="true" />
    <d2p1:CpvCodes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <d2p1:DeadlineFrom i:nil="true" />
    <d2p1:DeadlineTo i:nil="true" />
    <d2p1:IsSubcontract i:nil="true" />
    <d2p1:Keyword>Window cleaning</d2p1:Keyword>
    <d2p1:Postcode i:nil="true" />
    <d2p1:PublishedFrom i:nil="true" />
    <d2p1:PublishedTo i:nil="true" />
    <d2p1:QueryString i:nil="true" />
    <d2p1:Radius>0.0</d2p1:Radius>
    <d2p1:Regions>Wales,South East</d2p1:Regions>
    <d2p1:Statuses>
      <d2p1:NoticeStatus>Open</d2p1:NoticeStatus>
    </d2p1:Statuses>
    <d2p1:SuitableForSme>true</d2p1:SuitableForSme>
    <d2p1:SuitableForVco>false</d2p1:SuitableForVco>
    <d2p1:Types>
      <d2p1:NoticeType>Contract</d2p1:NoticeType>
      <d2p1:NoticeType>Pipeline</d2p1:NoticeType>
    </d2p1:Types>
    <d2p1:ValueFrom>3000.0</d2p1:ValueFrom>
    <d2p1:ValueTo>20000.0</d2p1:ValueTo>
  </SearchCriteria>
  <Size>1000</Size>
</NoticeSearchRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A collection of notice summaries matching the search criteria.

NoticeSearchResponse

Name	Description	Type	Additional information
HitCount	Gets or sets the hit count	integer	None.
NoticeList	Gets or sets the Notice list	Collection of HitOfNoticeIndex	None.
MaxHits	Gets or sets the Maximum hits returned by the search engine, or 0 if unlimited	integer	None.
ByRegion	Gets or sets the aggregations by region	StatisticsOfString	None.
ByType	Gets or sets the aggregations by notice type	StatisticsOfNullableOfNoticeType	None.
ByStatus	Gets or sets the aggregations by notice status	StatisticsOfNullableOfNoticeStatus	None.

Response Formats

HTTP response status code: 200

application/json, text/json

Sample:

{
  "hitCount": 1,
  "noticeList": [
    {
      "score": 1.1,
      "item": {
        "id": "sample string 1",
        "parentId": "sample string 2",
        "noticeIdentifier": "sample string 3",
        "title": "sample string 4",
        "description": "sample string 5",
        "cpvDescription": "sample string 6",
        "cpvDescriptionExpanded": "sample string 7",
        "publishedDate": "2016-09-12T11:23:39+01:00",
        "deadlineDate": "2016-09-12T11:23:39+01:00",
        "awardedDate": "2016-09-12T11:23:39+01:00",
        "awardedValue": 1.0,
        "awardedSupplier": "sample string 10",
        "approachMarketDate": "2016-09-12T11:23:39+01:00",
        "valueLow": 11.0,
        "valueHigh": 1.0,
        "postcode": "sample string 12",
        "coordinates": "sample string 13",
        "isSubNotice": true,
        "noticeType": "sample string 14",
        "noticeStatus": "sample string 15",
        "isSuitableForSme": true,
        "isSuitableForVco": true,
        "lastNotifiableUpdate": "2016-09-12T11:23:39+01:00",
        "organisationName": "sample string 19",
        "sector": "sample string 20",
        "cpvCodes": "sample string 21",
        "cpvCodesExtended": "sample string 22",
        "region": "sample string 23",
        "regionText": "sample string 24",
        "start": "2016-09-12T11:23:39+01:00",
        "end": "2016-09-12T11:23:39+01:00"
      }
    },
    {
      "score": 1.1,
      "item": {
        "id": "sample string 1",
        "parentId": "sample string 2",
        "noticeIdentifier": "sample string 3",
        "title": "sample string 4",
        "description": "sample string 5",
        "cpvDescription": "sample string 6",
        "cpvDescriptionExpanded": "sample string 7",
        "publishedDate": "2016-09-12T11:23:39+01:00",
        "deadlineDate": "2016-09-12T11:23:39+01:00",
        "awardedDate": "2016-09-12T11:23:39+01:00",
        "awardedValue": 1.0,
        "awardedSupplier": "sample string 10",
        "approachMarketDate": "2016-09-12T11:23:39+01:00",
        "valueLow": 11.0,
        "valueHigh": 1.0,
        "postcode": "sample string 12",
        "coordinates": "sample string 13",
        "isSubNotice": true,
        "noticeType": "sample string 14",
        "noticeStatus": "sample string 15",
        "isSuitableForSme": true,
        "isSuitableForVco": true,
        "lastNotifiableUpdate": "2016-09-12T11:23:39+01:00",
        "organisationName": "sample string 19",
        "sector": "sample string 20",
        "cpvCodes": "sample string 21",
        "cpvCodesExtended": "sample string 22",
        "region": "sample string 23",
        "regionText": "sample string 24",
        "start": "2016-09-12T11:23:39+01:00",
        "end": "2016-09-12T11:23:39+01:00"
      }
    }
  ],
  "maxHits": 2,
  "byRegion": {
    "other": 1,
    "items": [
      {
        "key": "sample string 1",
        "value": 2
      },
      {
        "key": "sample string 1",
        "value": 2
      }
    ]
  },
  "byType": {
    "other": 1,
    "items": [
      {
        "key": "Contract",
        "value": 1
      },
      {
        "key": "Contract",
        "value": 1
      }
    ]
  },
  "byStatus": {
    "other": 1,
    "items": [
      {
        "key": "Open",
        "value": 1
      },
      {
        "key": "Open",
        "value": 1
      }
    ]
  }
}

application/xml, text/xml

Sample:

<NoticeSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IPL.ContractsFinder.WebApi.Shared.Models">
  <ByRegion xmlns:d2p1="http://schemas.datacontract.org/2004/07/IPL.ContractsFinder.BusinessEntities">
    <d2p1:Items xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
      <d3p1:KeyValuePairOfstringlong>
        <d3p1:key>sample string 1</d3p1:key>
        <d3p1:value>2</d3p1:value>
      </d3p1:KeyValuePairOfstringlong>
      <d3p1:KeyValuePairOfstringlong>
        <d3p1:key>sample string 1</d3p1:key>
        <d3p1:value>2</d3p1:value>
      </d3p1:KeyValuePairOfstringlong>
    </d2p1:Items>
    <d2p1:Other>1</d2p1:Other>
  </ByRegion>
  <ByStatus xmlns:d2p1="http://schemas.datacontract.org/2004/07/IPL.ContractsFinder.BusinessEntities">
    <d2p1:Items xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
      <d3p1:KeyValuePairOfNullableOfNoticeStatusOKv1OWnglongRDHGY3MA>
        <d3p1:key>Open</d3p1:key>
        <d3p1:value>1</d3p1:value>
      </d3p1:KeyValuePairOfNullableOfNoticeStatusOKv1OWnglongRDHGY3MA>
      <d3p1:KeyValuePairOfNullableOfNoticeStatusOKv1OWnglongRDHGY3MA>
        <d3p1:key>Open</d3p1:key>
        <d3p1:value>1</d3p1:value>
      </d3p1:KeyValuePairOfNullableOfNoticeStatusOKv1OWnglongRDHGY3MA>
    </d2p1:Items>
    <d2p1:Other>1</d2p1:Other>
  </ByStatus>
  <ByType xmlns:d2p1="http://schemas.datacontract.org/2004/07/IPL.ContractsFinder.BusinessEntities">
    <d2p1:Items xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
      <d3p1:KeyValuePairOfNullableOfNoticeTypeOKv1OWnglongRDHGY3MA>
        <d3p1:key>Contract</d3p1:key>
        <d3p1:value>1</d3p1:value>
      </d3p1:KeyValuePairOfNullableOfNoticeTypeOKv1OWnglongRDHGY3MA>
      <d3p1:KeyValuePairOfNullableOfNoticeTypeOKv1OWnglongRDHGY3MA>
        <d3p1:key>Contract</d3p1:key>
        <d3p1:value>1</d3p1:value>
      </d3p1:KeyValuePairOfNullableOfNoticeTypeOKv1OWnglongRDHGY3MA>
    </d2p1:Items>
    <d2p1:Other>1</d2p1:Other>
  </ByType>
  <HitCount>1</HitCount>
  <MaxHits>2</MaxHits>
  <NoticeList xmlns:d2p1="http://schemas.datacontract.org/2004/07/IPL.ContractsFinder.BusinessEntities">
    <d2p1:HitOfNoticeIndexOKv1OWng>
      <d2p1:_x003C_Item_x003E_k__BackingField>
        <d2p1:_x003C_ApproachMarketDate_x003E_k__BackingField>2016-09-12T11:23:39+01:00</d2p1:_x003C_ApproachMarketDate_x003E_k__BackingField>
        <d2p1:_x003C_AwardedDate_x003E_k__BackingField>2016-09-12T11:23:39+01:00</d2p1:_x003C_AwardedDate_x003E_k__BackingField>
        <d2p1:_x003C_AwardedSupplier_x003E_k__BackingField>sample string 10</d2p1:_x003C_AwardedSupplier_x003E_k__BackingField>
        <d2p1:_x003C_AwardedValue_x003E_k__BackingField>1</d2p1:_x003C_AwardedValue_x003E_k__BackingField>
        <d2p1:_x003C_Coordinates_x003E_k__BackingField>sample string 13</d2p1:_x003C_Coordinates_x003E_k__BackingField>
        <d2p1:_x003C_CpvCodesExtended_x003E_k__BackingField>sample string 22</d2p1:_x003C_CpvCodesExtended_x003E_k__BackingField>
        <d2p1:_x003C_CpvCodes_x003E_k__BackingField>sample string 21</d2p1:_x003C_CpvCodes_x003E_k__BackingField>
        <d2p1:_x003C_CpvDescriptionExpanded_x003E_k__BackingField>sample string 7</d2p1:_x003C_CpvDescriptionExpanded_x003E_k__BackingField>
        <d2p1:_x003C_CpvDescription_x003E_k__BackingField>sample string 6</d2p1:_x003C_CpvDescription_x003E_k__BackingField>
        <d2p1:_x003C_DeadlineDate_x003E_k__BackingField>2016-09-12T11:23:39+01:00</d2p1:_x003C_DeadlineDate_x003E_k__BackingField>
        <d2p1:_x003C_Description_x003E_k__BackingField>sample string 5</d2p1:_x003C_Description_x003E_k__BackingField>
        <d2p1:_x003C_End_x003E_k__BackingField>2016-09-12T11:23:39+01:00</d2p1:_x003C_End_x003E_k__BackingField>
        <d2p1:_x003C_Id_x003E_k__BackingField>sample string 1</d2p1:_x003C_Id_x003E_k__BackingField>
        <d2p1:_x003C_IsSuitableForSme_x003E_k__BackingField>true</d2p1:_x003C_IsSuitableForSme_x003E_k__BackingField>
        <d2p1:_x003C_IsSuitableForVco_x003E_k__BackingField>true</d2p1:_x003C_IsSuitableForVco_x003E_k__BackingField>
        <d2p1:_x003C_LastNotifiableUpdate_x003E_k__BackingField>2016-09-12T11:23:39+01:00</d2p1:_x003C_LastNotifiableUpdate_x003E_k__BackingField>
        <d2p1:_x003C_NoticeIdentifier_x003E_k__BackingField>sample string 3</d2p1:_x003C_NoticeIdentifier_x003E_k__BackingField>
        <d2p1:_x003C_NoticeStatus_x003E_k__BackingField>sample string 15</d2p1:_x003C_NoticeStatus_x003E_k__BackingField>
        <d2p1:_x003C_NoticeType_x003E_k__BackingField>sample string 14</d2p1:_x003C_NoticeType_x003E_k__BackingField>
        <d2p1:_x003C_OrganisationName_x003E_k__BackingField>sample string 19</d2p1:_x003C_OrganisationName_x003E_k__BackingField>
        <d2p1:_x003C_ParentId_x003E_k__BackingField>sample string 2</d2p1:_x003C_ParentId_x003E_k__BackingField>
        <d2p1:_x003C_Postcode_x003E_k__BackingField>sample string 12</d2p1:_x003C_Postcode_x003E_k__BackingField>
        <d2p1:_x003C_PublishedDate_x003E_k__BackingField>2016-09-12T11:23:39+01:00</d2p1:_x003C_PublishedDate_x003E_k__BackingField>
        <d2p1:_x003C_RegionText_x003E_k__BackingField>sample string 24</d2p1:_x003C_RegionText_x003E_k__BackingField>
        <d2p1:_x003C_Region_x003E_k__BackingField>sample string 23</d2p1:_x003C_Region_x003E_k__BackingField>
        <d2p1:_x003C_Sector_x003E_k__BackingField>sample string 20</d2p1:_x003C_Sector_x003E_k__BackingField>
        <d2p1:_x003C_Start_x003E_k__BackingField>2016-09-12T11:23:39+01:00</d2p1:_x003C_Start_x003E_k__BackingField>
        <d2p1:_x003C_Title_x003E_k__BackingField>sample string 4</d2p1:_x003C_Title_x003E_k__BackingField>
        <d2p1:_x003C_ValueHigh_x003E_k__BackingField>1</d2p1:_x003C_ValueHigh_x003E_k__BackingField>
        <d2p1:_x003C_ValueLow_x003E_k__BackingField>11</d2p1:_x003C_ValueLow_x003E_k__BackingField>
      </d2p1:_x003C_Item_x003E_k__BackingField>
      <d2p1:_x003C_Score_x003E_k__BackingField>1.1</d2p1:_x003C_Score_x003E_k__BackingField>
    </d2p1:HitOfNoticeIndexOKv1OWng>
    <d2p1:HitOfNoticeIndexOKv1OWng>
      <d2p1:_x003C_Item_x003E_k__BackingField>
        <d2p1:_x003C_ApproachMarketDate_x003E_k__BackingField>2016-09-12T11:23:39+01:00</d2p1:_x003C_ApproachMarketDate_x003E_k__BackingField>
        <d2p1:_x003C_AwardedDate_x003E_k__BackingField>2016-09-12T11:23:39+01:00</d2p1:_x003C_AwardedDate_x003E_k__BackingField>
        <d2p1:_x003C_AwardedSupplier_x003E_k__BackingField>sample string 10</d2p1:_x003C_AwardedSupplier_x003E_k__BackingField>
        <d2p1:_x003C_AwardedValue_x003E_k__BackingField>1</d2p1:_x003C_AwardedValue_x003E_k__BackingField>
        <d2p1:_x003C_Coordinates_x003E_k__BackingField>sample string 13</d2p1:_x003C_Coordinates_x003E_k__BackingField>
        <d2p1:_x003C_CpvCodesExtended_x003E_k__BackingField>sample string 22</d2p1:_x003C_CpvCodesExtended_x003E_k__BackingField>
        <d2p1:_x003C_CpvCodes_x003E_k__BackingField>sample string 21</d2p1:_x003C_CpvCodes_x003E_k__BackingField>
        <d2p1:_x003C_CpvDescriptionExpanded_x003E_k__BackingField>sample string 7</d2p1:_x003C_CpvDescriptionExpanded_x003E_k__BackingField>
        <d2p1:_x003C_CpvDescription_x003E_k__BackingField>sample string 6</d2p1:_x003C_CpvDescription_x003E_k__BackingField>
        <d2p1:_x003C_DeadlineDate_x003E_k__BackingField>2016-09-12T11:23:39+01:00</d2p1:_x003C_DeadlineDate_x003E_k__BackingField>
        <d2p1:_x003C_Description_x003E_k__BackingField>sample string 5</d2p1:_x003C_Description_x003E_k__BackingField>
        <d2p1:_x003C_End_x003E_k__BackingField>2016-09-12T11:23:39+01:00</d2p1:_x003C_End_x003E_k__BackingField>
        <d2p1:_x003C_Id_x003E_k__BackingField>sample string 1</d2p1:_x003C_Id_x003E_k__BackingField>
        <d2p1:_x003C_IsSuitableForSme_x003E_k__BackingField>true</d2p1:_x003C_IsSuitableForSme_x003E_k__BackingField>
        <d2p1:_x003C_IsSuitableForVco_x003E_k__BackingField>true</d2p1:_x003C_IsSuitableForVco_x003E_k__BackingField>
        <d2p1:_x003C_LastNotifiableUpdate_x003E_k__BackingField>2016-09-12T11:23:39+01:00</d2p1:_x003C_LastNotifiableUpdate_x003E_k__BackingField>
        <d2p1:_x003C_NoticeIdentifier_x003E_k__BackingField>sample string 3</d2p1:_x003C_NoticeIdentifier_x003E_k__BackingField>
        <d2p1:_x003C_NoticeStatus_x003E_k__BackingField>sample string 15</d2p1:_x003C_NoticeStatus_x003E_k__BackingField>
        <d2p1:_x003C_NoticeType_x003E_k__BackingField>sample string 14</d2p1:_x003C_NoticeType_x003E_k__BackingField>
        <d2p1:_x003C_OrganisationName_x003E_k__BackingField>sample string 19</d2p1:_x003C_OrganisationName_x003E_k__BackingField>
        <d2p1:_x003C_ParentId_x003E_k__BackingField>sample string 2</d2p1:_x003C_ParentId_x003E_k__BackingField>
        <d2p1:_x003C_Postcode_x003E_k__BackingField>sample string 12</d2p1:_x003C_Postcode_x003E_k__BackingField>
        <d2p1:_x003C_PublishedDate_x003E_k__BackingField>2016-09-12T11:23:39+01:00</d2p1:_x003C_PublishedDate_x003E_k__BackingField>
        <d2p1:_x003C_RegionText_x003E_k__BackingField>sample string 24</d2p1:_x003C_RegionText_x003E_k__BackingField>
        <d2p1:_x003C_Region_x003E_k__BackingField>sample string 23</d2p1:_x003C_Region_x003E_k__BackingField>
        <d2p1:_x003C_Sector_x003E_k__BackingField>sample string 20</d2p1:_x003C_Sector_x003E_k__BackingField>
        <d2p1:_x003C_Start_x003E_k__BackingField>2016-09-12T11:23:39+01:00</d2p1:_x003C_Start_x003E_k__BackingField>
        <d2p1:_x003C_Title_x003E_k__BackingField>sample string 4</d2p1:_x003C_Title_x003E_k__BackingField>
        <d2p1:_x003C_ValueHigh_x003E_k__BackingField>1</d2p1:_x003C_ValueHigh_x003E_k__BackingField>
        <d2p1:_x003C_ValueLow_x003E_k__BackingField>11</d2p1:_x003C_ValueLow_x003E_k__BackingField>
      </d2p1:_x003C_Item_x003E_k__BackingField>
      <d2p1:_x003C_Score_x003E_k__BackingField>1.1</d2p1:_x003C_Score_x003E_k__BackingField>
    </d2p1:HitOfNoticeIndexOKv1OWng>
  </NoticeList>
</NoticeSearchResponse>

HTTP response status code: 403

When the user has submitted too many requests, no further requests should be made until after 5 minutes

text/plain

Sample:

Body:

<html><head><title>Forbidden - Contracts Finder</title></head><body><p><h1><strong>Request forbidden</strong></h1></p><p>The request rate limit may have been exceeded. If you believe this is an error <a href="https://www.contractsfinder.service.gov.uk/Home/Contact">contact us</a> quoting 0QrFmYQAAAABs5RRpp9L8RbtJ8k4jz8gwTE9OMjFFREdFMDIwOABiYTEyMjkxMi0zZWE0LTQ1NTQtYjNjNi1mNmRmZDU2MGY2ZDM=.</p></body></html>