GET CpvCodes/Search/{identifier}
Gets a collection of CPVCode objects based on the supplied identifier. If the identifier is numeric then the lookup will match against the CPV code, otherwise it will match against the CPV description.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
identifier |
The search text, either a numeric CPV code or simple search text. |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
A collection of CPVCode objects wrapped in a CpvCodesResponse.
CpvCodesResponseName | Description | Type | Additional information |
---|---|---|---|
Codes |
Gets or sets list of available codes |
Collection of CpvCode |
None. |
Response Formats
HTTP response status code: 200
application/json, text/json
{ "codes": [ { "code": "44618420", "description": "Food cans", "parentCode": "44618000", "hasChildren": false }, { "code": "51542000", "description": "Installation of food-processing machinery", "parentCode": "51540000", "hasChildren": false } ] }
application/xml, text/xml
<CpvCodesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IPL.ContractsFinder.WebApi.Shared.Models"> <Codes xmlns:d2p1="http://schemas.datacontract.org/2004/07/IPL.ContractsFinder.BusinessEntities"> <d2p1:CpvCode> <d2p1:Code>44618420</d2p1:Code> <d2p1:Description>Food cans</d2p1:Description> <d2p1:HasChildren>false</d2p1:HasChildren> <d2p1:ParentCode>44618000</d2p1:ParentCode> </d2p1:CpvCode> <d2p1:CpvCode> <d2p1:Code>51542000</d2p1:Code> <d2p1:Description>Installation of food-processing machinery</d2p1:Description> <d2p1:HasChildren>false</d2p1:HasChildren> <d2p1:ParentCode>51540000</d2p1:ParentCode> </d2p1:CpvCode> </Codes> </CpvCodesResponse>
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>