Food Hygiene Rating API Version 2 Resource Detail

GET Authorities

Returns details of all authorities, results are unbound.

Request Information

Request body formats

application/json, text/json

Sample: 
{
  "authorities": [
    {
      "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-12-04T08:34:47.4866714+00:00",
      "LastPublishedDate": "2024-12-04T08:34:47.4866714+00:00",
      "SchemeType": 14,
      "links": [
        {
          "rel": "sample string 1",
          "href": "sample string 2"
        },
        {
          "rel": "sample string 1",
          "href": "sample string 2"
        }
      ]
    },
    {
      "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-12-04T08:34:47.4866714+00:00",
      "LastPublishedDate": "2024-12-04T08:34:47.4866714+00:00",
      "SchemeType": 14,
      "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:34:47.4866714+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: 
<AuthorityDetailCollection 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>
  </links>
  <meta xmlns="http://schemas.datacontract.org/2004/07/FHRS.Model.MetaLinks">
    <dataSource>sample string 1</dataSource>
    <extractDate>2024-12-04T08:34:47.4866714+00:00</extractDate>
    <itemCount>3</itemCount>
    <pageNumber>8</pageNumber>
    <pageSize>7</pageSize>
    <returncode>sample string 4</returncode>
    <totalCount>5</totalCount>
    <totalPages>6</totalPages>
  </meta>
  <authorities>
    <authority>
      <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>
      <CreationDate>2024-12-04T08:34:47.4866714+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-12-04T08:34:47.4866714+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>
    <authority>
      <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>
      <CreationDate>2024-12-04T08:34:47.4866714+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-12-04T08:34:47.4866714+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>
  </authorities>
</AuthorityDetailCollection>

application/x-www-form-urlencoded

Sample: 
Currently Unsupported :(
Test API
URI parameters
=
Headers | Add header
: Delete
Body
Samples:
Status
Headers
Body