POST api/rest/2/search_notices/{MimeType}
For the Version 1 equivalent method, please visit POST Searches/Search. 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.
Searches for notices based on the provided search criteria.
Request Information
URI Parameters
None.
Body Parameters
The search criteria.
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
{ "searchCriteria": { "types": [ "Contract" ], "statuses": [ "Awarded" ], "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, "awardedToSme": true, "awardedToVcse": false, "cpvCodes": null }, "size": 1000 }
application/xml, text/xml
<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>Awarded</d2p1:NoticeStatus> </d2p1:Statuses> <d2p1:SuitableForSme>true</d2p1:SuitableForSme> <d2p1:SuitableForVco>false</d2p1:SuitableForVco> <d2p1:AwardedToSme>true</d2p1:AwardedToSme> <d2p1:AwardedToVcse>false</d2p1:AwardedToVcse> <d2p1:Types> <d2p1:NoticeType>Contract</d2p1:NoticeType> </d2p1:Types> <d2p1:ValueFrom>3000.0</d2p1:ValueFrom> <d2p1:ValueTo>20000.0</d2p1:ValueTo> </SearchCriteria> <Size>1000</Size> </NoticeSearchRequest>
Response Information
Resource Description
A collection of notice summaries matching the search criteria.
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
{ "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, "awardedToSme": true, "awardedToVcse": false, "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, "awardedToSme": true, "awardedToVcse": false, "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
<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:KeyValuePairOfNullableOfNoticeStatus> <d3p1:key>Open</d3p1:key> <d3p1:value>1</d3p1:value> </d3p1:KeyValuePairOfNullableOfNoticeStatus> <d3p1:KeyValuePairOfNullableOfNoticeStatus> <d3p1:key>Open</d3p1:key> <d3p1:value>1</d3p1:value> </d3p1:KeyValuePairOfNullableOfNoticeStatus> </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:KeyValuePairOfNullableOfNoticeType> <d3p1:key>Contract</d3p1:key> <d3p1:value>1</d3p1:value> </d3p1:KeyValuePairOfNullableOfNoticeType> <d3p1:KeyValuePairOfNullableOfNoticeType> <d3p1:key>Contract</d3p1:key> <d3p1:value>1</d3p1:value> </d3p1:KeyValuePairOfNullableOfNoticeType> </d2p1:Items> <d2p1:Other>1</d2p1:Other> </ByType> <HitCount>2</HitCount> <MaxHits>2</MaxHits> <NoticeList xmlns:d2p1="http://schemas.datacontract.org/2004/07/IPL.ContractsFinder.BusinessEntities"> <d2p1:HitOfNoticeIndex> <d2p1:Item> <d2p1:ApproachMarketDate>2016-09-12T11:23:39+01:00</d2p1:ApproachMarketDate> <d2p1:AwardedDate>2016-09-12T11:23:39+01:00</d2p1:AwardedDate> <d2p1:AwardedSupplier>sample string 10</d2p1:AwardedSupplier> <d2p1:AwardedValue>1</d2p1:AwardedValue> <d2p1:Coordinates>sample string 13</d2p1:Coordinates> <d2p1:CpvCodesExtended>sample string 22</d2p1:CpvCodesExtended> <d2p1:CpvCodes>sample string 21</d2p1:CpvCodes> <d2p1:CpvDescriptionExpanded>sample string 7</d2p1:CpvDescriptionExpanded> <d2p1:CpvDescription>sample string 6</d2p1:CpvDescription> <d2p1:DeadlineDate>2016-09-12T11:23:39+01:00</d2p1:DeadlineDate> <d2p1:Description>sample string 5</d2p1:Description> <d2p1:End>2016-09-12T11:23:39+01:00</d2p1:End> <d2p1:Id>sample string 1</d2p1:Id> <d2p1:IsSuitableForSme>true</d2p1:IsSuitableForSme> <d2p1:IsSuitableForVco>true</d2p1:IsSuitableForVco> <d2p1:AwardedToSme>true</d2p1:AwardedToSme> <d2p1:AwardedToVcse>false</d2p1:AwardedToVcse> <d2p1:LastNotifiableUpdate>2016-09-12T11:23:39+01:00</d2p1:LastNotifiableUpdate> <d2p1:NoticeIdentifier>sample string 3</d2p1:NoticeIdentifier> <d2p1:NoticeStatus>sample string 15</d2p1:NoticeStatus> <d2p1:NoticeType>sample string 14</d2p1:NoticeType> <d2p1:OrganisationName>sample string 19</d2p1:OrganisationName> <d2p1:ParentId>sample string 2</d2p1:ParentId> <d2p1:Postcode>sample string 12</d2p1:Postcode> <d2p1:PublishedDate>2016-09-12T11:23:39+01:00</d2p1:PublishedDate> <d2p1:RegionText>sample string 24</d2p1:RegionText> <d2p1:Region>sample string 23</d2p1:Region> <d2p1:Sector>sample string 20</d2p1:Sector> <d2p1:Start>2016-09-12T11:23:39+01:00</d2p1:Start> <d2p1:Title>sample string 4</d2p1:Title> <d2p1:ValueHigh>1</d2p1:ValueHigh> <d2p1:ValueLow>11</d2p1:ValueLow> </d2p1:Item> <d2p1:Score>1.1</d2p1:Score> </d2p1:HitOfNoticeIndex> <d2p1:HitOfNoticeIndex> <d2p1:Item> <d2p1:ApproachMarketDate>2016-09-12T11:23:39+01:00</d2p1:ApproachMarketDate> <d2p1:AwardedDate>2016-09-12T11:23:39+01:00</d2p1:AwardedDate> <d2p1:AwardedSupplier>sample string 10</d2p1:AwardedSupplier> <d2p1:AwardedValue>1</d2p1:AwardedValue> <d2p1:Coordinates>sample string 13</d2p1:Coordinates> <d2p1:CpvCodesExtended>sample string 22</d2p1:CpvCodesExtended> <d2p1:CpvCodes>sample string 21</d2p1:CpvCodes> <d2p1:CpvDescriptionExpanded>sample string 7</d2p1:CpvDescriptionExpanded> <d2p1:CpvDescription>sample string 6</d2p1:CpvDescription> <d2p1:DeadlineDate>2016-09-12T11:23:39+01:00</d2p1:DeadlineDate> <d2p1:Description>sample string 5</d2p1:Description> <d2p1:End>2016-09-12T11:23:39+01:00</d2p1:End> <d2p1:Id>sample string 1</d2p1:Id> <d2p1:IsSuitableForSme>true</d2p1:IsSuitableForSme> <d2p1:IsSuitableForVco>true</d2p1:IsSuitableForVco> <d2p1:AwardedToSme>true</d2p1:AwardedToSme> <d2p1:AwardedToVcse>false</d2p1:AwardedToVcse> <d2p1:LastNotifiableUpdate>2016-09-12T11:23:39+01:00</d2p1:LastNotifiableUpdate> <d2p1:NoticeIdentifier>sample string 3</d2p1:NoticeIdentifier> <d2p1:NoticeStatus>sample string 15</d2p1:NoticeStatus> <d2p1:NoticeType>sample string 14</d2p1:NoticeType> <d2p1:OrganisationName>sample string 19</d2p1:OrganisationName> <d2p1:ParentId>sample string 2</d2p1:ParentId> <d2p1:Postcode>sample string 12</d2p1:Postcode> <d2p1:PublishedDate>2016-09-12T11:23:39+01:00</d2p1:PublishedDate> <d2p1:RegionText>sample string 24</d2p1:RegionText> <d2p1:Region>sample string 23</d2p1:Region> <d2p1:Sector>sample string 20</d2p1:Sector> <d2p1:Start>2016-09-12T11:23:39+01:00</d2p1:Start> <d2p1:Title>sample string 4</d2p1:Title> <d2p1:ValueHigh>1</d2p1:ValueHigh> <d2p1:ValueLow>11</d2p1:ValueLow> </d2p1:Item> <d2p1:Score>1.1</d2p1:Score> </d2p1:HitOfNoticeIndex> </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
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>