GET Region/Regions

Gets all Region data relevant to the Contracts Finder system.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

A RegionResponse containing all the Region data.

RegionResponse

Name	Description	Type	Additional information
Regions	Gets or sets list of regions.	Collection of Region	None.

Response Formats

HTTP response status code: 200

application/json, text/json

Sample:

{
  "regions": [
    {
      "id": 1,
      "name": "East Midlands"
    },
    {
      "id": 2,
      "name": "London"
    },
    {
      "id": 3,
      "name": "Wales"
    }
  ]
}

application/xml, text/xml

Sample:

<RegionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IPL.ContractsFinder.WebApi.Shared.Models">
  <Regions xmlns:d2p1="http://schemas.datacontract.org/2004/07/IPL.ContractsFinder.BusinessEntities">
    <d2p1:Region>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>East Midlands</d2p1:Name>
    </d2p1:Region>
    <d2p1:Region>
      <d2p1:Id>2</d2p1:Id>
      <d2p1:Name>London</d2p1:Name>
    </d2p1:Region>
    <d2p1:Region>
      <d2p1:Id>3</d2p1:Id>
      <d2p1:Name>Wales</d2p1:Name>
    </d2p1:Region>
  </Regions>
</RegionResponse>

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>