Food Hygiene Rating API Version 2 Resource Detail

GET Authorities/{id}

Returns details of a single authority, selected by Id.

Request Information

Parameters

NameDescriptionAdditional information
id The target Authority Id.

Define this parameter in the request URI.

Request body formats

application/json, text/json

Sample:
{
  "LocalAuthorityId": 1,
  "LocalAuthorityIdCode": "sample string 2",
  "Name": "sample string 3",
  "FriendlyName": "sample string 4",
  "Url": "sample string 5",
  "SchemeUrl": "sample string 6",
  "Email": "sample string 7",
  "RegionName": "sample string 8",
  "FileName": "sample string 9",
  "FileNameWelsh": "sample string 10",
  "EstablishmentCount": 11,
  "CreationDate": "2024-03-29T01:43:08.067727+00:00",
  "LastPublishedDate": "2024-03-29T01:43:08.067727+00:00",
  "SchemeType": 14,
  "links": [
    {
      "rel": "sample string 1",
      "href": "sample string 2"
    },
    {
      "rel": "sample string 1",
      "href": "sample string 2"
    },
    {
      "rel": "sample string 1",
      "href": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<authority xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FHRS.Model.Detailed">
  <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>
    <link>
      <href>sample string 2</href>
      <rel>sample string 1</rel>
    </link>
  </links>
  <CreationDate>2024-03-29T01:43:08.067727+00:00</CreationDate>
  <Email>sample string 7</Email>
  <EstablishmentCount>11</EstablishmentCount>
  <FileName>sample string 9</FileName>
  <FileNameWelsh>sample string 10</FileNameWelsh>
  <FriendlyName>sample string 4</FriendlyName>
  <LastPublishedDate>2024-03-29T01:43:08.067727+00:00</LastPublishedDate>
  <LocalAuthorityId>1</LocalAuthorityId>
  <LocalAuthorityIdCode>sample string 2</LocalAuthorityIdCode>
  <Name>sample string 3</Name>
  <RegionName>sample string 8</RegionName>
  <SchemeType>14</SchemeType>
  <SchemeUrl>sample string 6</SchemeUrl>
  <Url>sample string 5</Url>
</authority>

application/x-www-form-urlencoded

Sample:

Sample not available.

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