Food Hygiene Rating API Version 2 Resource Detail

GET Establishments/basic/{pageNumber}/{pageSize}

Returns a basic list of establishments (id/name), details can be retrieved by calling establishments/{id}, page parameters allow for page number and size specification.

Request Information

Parameters

NameDescriptionAdditional information
pageNumber The page number.

Define this parameter in the request URI.
pageSize Size of the page.

Define this parameter in the request URI.

Request body formats

application/json, text/json

Sample: 
{
  "establishments": [
    {
      "FHRSID": 1,
      "LocalAuthorityBusinessID": "sample string 2",
      "BusinessName": "sample string 3",
      "BusinessType": "sample string 4",
      "RatingValue": "sample string 5",
      "RatingDate": "2024-12-04T08:25:46.749159+00:00",
      "links": [
        {
          "rel": "sample string 1",
          "href": "sample string 2"
        },
        {
          "rel": "sample string 1",
          "href": "sample string 2"
        }
      ]
    },
    {
      "FHRSID": 1,
      "LocalAuthorityBusinessID": "sample string 2",
      "BusinessName": "sample string 3",
      "BusinessType": "sample string 4",
      "RatingValue": "sample string 5",
      "RatingDate": "2024-12-04T08:25:46.749159+00:00",
      "links": [
        {
          "rel": "sample string 1",
          "href": "sample string 2"
        },
        {
          "rel": "sample string 1",
          "href": "sample string 2"
        }
      ]
    }
  ],
  "meta": {
    "dataSource": "sample string 1",
    "extractDate": "2024-12-04T08:25:46.749159+00:00",
    "itemCount": 3,
    "returncode": "sample string 4",
    "totalCount": 5,
    "totalPages": 6,
    "pageSize": 7,
    "pageNumber": 8
  },
  "links": [
    {
      "rel": "sample string 1",
      "href": "sample string 2"
    },
    {
      "rel": "sample string 1",
      "href": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample: 
<EstablishmentCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FHRS.Model.Basic">
  <links xmlns="http://schemas.datacontract.org/2004/07/FHRS.Model.MetaLinks">
    <link>
      <href>sample string 2</href>
      <rel>sample string 1</rel>
    </link>
    <link>
      <href>sample string 2</href>
      <rel>sample string 1</rel>
    </link>
  </links>
  <meta xmlns="http://schemas.datacontract.org/2004/07/FHRS.Model.MetaLinks">
    <dataSource>sample string 1</dataSource>
    <extractDate>2024-12-04T08:25:46.749159+00:00</extractDate>
    <itemCount>3</itemCount>
    <pageNumber>8</pageNumber>
    <pageSize>7</pageSize>
    <returncode>sample string 4</returncode>
    <totalCount>5</totalCount>
    <totalPages>6</totalPages>
  </meta>
  <establishments>
    <establishments>
      <links xmlns="http://schemas.datacontract.org/2004/07/FHRS.Model.MetaLinks">
        <link>
          <href>sample string 2</href>
          <rel>sample string 1</rel>
        </link>
        <link>
          <href>sample string 2</href>
          <rel>sample string 1</rel>
        </link>
      </links>
      <BusinessName>sample string 3</BusinessName>
      <BusinessType>sample string 4</BusinessType>
      <FHRSID>1</FHRSID>
      <LocalAuthorityBusinessID>sample string 2</LocalAuthorityBusinessID>
      <RatingDate>2024-12-04T08:25:46.749159+00:00</RatingDate>
      <RatingValue>sample string 5</RatingValue>
    </establishments>
    <establishments>
      <links xmlns="http://schemas.datacontract.org/2004/07/FHRS.Model.MetaLinks">
        <link>
          <href>sample string 2</href>
          <rel>sample string 1</rel>
        </link>
        <link>
          <href>sample string 2</href>
          <rel>sample string 1</rel>
        </link>
      </links>
      <BusinessName>sample string 3</BusinessName>
      <BusinessType>sample string 4</BusinessType>
      <FHRSID>1</FHRSID>
      <LocalAuthorityBusinessID>sample string 2</LocalAuthorityBusinessID>
      <RatingDate>2024-12-04T08:25:46.749159+00:00</RatingDate>
      <RatingValue>sample string 5</RatingValue>
    </establishments>
  </establishments>
</EstablishmentCollection>

application/x-www-form-urlencoded

Sample:

Sample not available.

Test API
URI parameters
=
Headers | Add header
: Delete
Body
Samples:
Status
Headers
Body