Food Hygiene Rating API Version 2 Resource Detail
GET Establishments/list
Returns a list of establishments, selected by Id.
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| id | The target Establishment Ids. Use the query string of the Uri to specify these e.g. /establishments/list?id=1&id=2&id=3... The maximum number of ids is limited to 50. |
Define this parameter in the request URI. |
Request body formats
application/json, text/json
Sample:
{
"establishments": [
{
"AddressLine1": "sample string 2",
"AddressLine2": "sample string 3",
"AddressLine3": "sample string 4",
"AddressLine4": "sample string 5",
"BusinessName": "sample string 1",
"BusinessType": "sample string 23",
"BusinessTypeID": 7,
"ChangesByServerID": 21,
"Distance": 1.1,
"FHRSID": 20,
"LocalAuthorityBusinessID": "sample string 22",
"LocalAuthorityCode": "sample string 8",
"LocalAuthorityEmailAddress": "sample string 30",
"LocalAuthorityName": "sample string 28",
"LocalAuthorityWebSite": "sample string 29",
"NewRatingPending": true,
"Phone": "sample string 24",
"PostCode": "sample string 6",
"RatingDate": "2024-04-29T13:51:31.0125714+01:00",
"RatingKey": "sample string 25",
"RatingValue": "sample string 10",
"RightToReply": "sample string 31",
"SchemeType": "sample string 13",
"geocode": {
"longitude": "1.1",
"latitude": "1.1"
},
"scores": {
"Hygiene": null,
"Structural": null,
"ConfidenceInManagement": null
}
},
{
"AddressLine1": "sample string 2",
"AddressLine2": "sample string 3",
"AddressLine3": "sample string 4",
"AddressLine4": "sample string 5",
"BusinessName": "sample string 1",
"BusinessType": "sample string 23",
"BusinessTypeID": 7,
"ChangesByServerID": 21,
"Distance": 1.1,
"FHRSID": 20,
"LocalAuthorityBusinessID": "sample string 22",
"LocalAuthorityCode": "sample string 8",
"LocalAuthorityEmailAddress": "sample string 30",
"LocalAuthorityName": "sample string 28",
"LocalAuthorityWebSite": "sample string 29",
"NewRatingPending": true,
"Phone": "sample string 24",
"PostCode": "sample string 6",
"RatingDate": "2024-04-29T13:51:31.0125714+01:00",
"RatingKey": "sample string 25",
"RatingValue": "sample string 10",
"RightToReply": "sample string 31",
"SchemeType": "sample string 13",
"geocode": {
"longitude": "1.1",
"latitude": "1.1"
},
"scores": {
"Hygiene": null,
"Structural": null,
"ConfidenceInManagement": null
}
},
{
"AddressLine1": "sample string 2",
"AddressLine2": "sample string 3",
"AddressLine3": "sample string 4",
"AddressLine4": "sample string 5",
"BusinessName": "sample string 1",
"BusinessType": "sample string 23",
"BusinessTypeID": 7,
"ChangesByServerID": 21,
"Distance": 1.1,
"FHRSID": 20,
"LocalAuthorityBusinessID": "sample string 22",
"LocalAuthorityCode": "sample string 8",
"LocalAuthorityEmailAddress": "sample string 30",
"LocalAuthorityName": "sample string 28",
"LocalAuthorityWebSite": "sample string 29",
"NewRatingPending": true,
"Phone": "sample string 24",
"PostCode": "sample string 6",
"RatingDate": "2024-04-29T13:51:31.0125714+01:00",
"RatingKey": "sample string 25",
"RatingValue": "sample string 10",
"RightToReply": "sample string 31",
"SchemeType": "sample string 13",
"geocode": {
"longitude": "1.1",
"latitude": "1.1"
},
"scores": {
"Hygiene": null,
"Structural": null,
"ConfidenceInManagement": null
}
}
],
"meta": {
"dataSource": "sample string 1",
"extractDate": "2024-04-29T13:51:31.0125714+01: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"
},
{
"rel": "sample string 1",
"href": "sample string 2"
}
]
}
application/xml, text/xml
Sample:
<EstablishmentDetailCollection 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>
<meta xmlns="http://schemas.datacontract.org/2004/07/FHRS.Model.MetaLinks">
<dataSource>sample string 1</dataSource>
<extractDate>2024-04-29T13:51:31.0125714+01:00</extractDate>
<itemCount>3</itemCount>
<pageNumber>8</pageNumber>
<pageSize>7</pageSize>
<returncode>sample string 4</returncode>
<totalCount>5</totalCount>
<totalPages>6</totalPages>
</meta>
<establishments>
<establishment>
<AddressLine1>sample string 2</AddressLine1>
<AddressLine2>sample string 3</AddressLine2>
<AddressLine3>sample string 4</AddressLine3>
<AddressLine4>sample string 5</AddressLine4>
<BusinessName>sample string 1</BusinessName>
<BusinessType>sample string 23</BusinessType>
<BusinessTypeID>7</BusinessTypeID>
<ChangesByServerID>21</ChangesByServerID>
<Distance>1.1</Distance>
<FHRSID>20</FHRSID>
<LocalAuthorityBusinessID>sample string 22</LocalAuthorityBusinessID>
<LocalAuthorityCode>sample string 8</LocalAuthorityCode>
<LocalAuthorityEmailAddress>sample string 30</LocalAuthorityEmailAddress>
<LocalAuthorityName>sample string 28</LocalAuthorityName>
<LocalAuthorityWebSite>sample string 29</LocalAuthorityWebSite>
<NewRatingPending>true</NewRatingPending>
<Phone>sample string 24</Phone>
<PostCode>sample string 6</PostCode>
<RatingDate>2024-04-29T13:51:31.0125714+01:00</RatingDate>
<RatingKey>sample string 25</RatingKey>
<RatingValue>sample string 10</RatingValue>
<RightToReply>sample string 31</RightToReply>
<SchemeType>sample string 13</SchemeType>
<geocode>
<latitude>1.1</latitude>
<longitude>1.1</longitude>
</geocode>
<scores>
<ConfidenceInManagement i:nil="true" />
<Hygiene i:nil="true" />
<Structural i:nil="true" />
</scores>
</establishment>
<establishment>
<AddressLine1>sample string 2</AddressLine1>
<AddressLine2>sample string 3</AddressLine2>
<AddressLine3>sample string 4</AddressLine3>
<AddressLine4>sample string 5</AddressLine4>
<BusinessName>sample string 1</BusinessName>
<BusinessType>sample string 23</BusinessType>
<BusinessTypeID>7</BusinessTypeID>
<ChangesByServerID>21</ChangesByServerID>
<Distance>1.1</Distance>
<FHRSID>20</FHRSID>
<LocalAuthorityBusinessID>sample string 22</LocalAuthorityBusinessID>
<LocalAuthorityCode>sample string 8</LocalAuthorityCode>
<LocalAuthorityEmailAddress>sample string 30</LocalAuthorityEmailAddress>
<LocalAuthorityName>sample string 28</LocalAuthorityName>
<LocalAuthorityWebSite>sample string 29</LocalAuthorityWebSite>
<NewRatingPending>true</NewRatingPending>
<Phone>sample string 24</Phone>
<PostCode>sample string 6</PostCode>
<RatingDate>2024-04-29T13:51:31.0125714+01:00</RatingDate>
<RatingKey>sample string 25</RatingKey>
<RatingValue>sample string 10</RatingValue>
<RightToReply>sample string 31</RightToReply>
<SchemeType>sample string 13</SchemeType>
<geocode>
<latitude>1.1</latitude>
<longitude>1.1</longitude>
</geocode>
<scores>
<ConfidenceInManagement i:nil="true" />
<Hygiene i:nil="true" />
<Structural i:nil="true" />
</scores>
</establishment>
<establishment>
<AddressLine1>sample string 2</AddressLine1>
<AddressLine2>sample string 3</AddressLine2>
<AddressLine3>sample string 4</AddressLine3>
<AddressLine4>sample string 5</AddressLine4>
<BusinessName>sample string 1</BusinessName>
<BusinessType>sample string 23</BusinessType>
<BusinessTypeID>7</BusinessTypeID>
<ChangesByServerID>21</ChangesByServerID>
<Distance>1.1</Distance>
<FHRSID>20</FHRSID>
<LocalAuthorityBusinessID>sample string 22</LocalAuthorityBusinessID>
<LocalAuthorityCode>sample string 8</LocalAuthorityCode>
<LocalAuthorityEmailAddress>sample string 30</LocalAuthorityEmailAddress>
<LocalAuthorityName>sample string 28</LocalAuthorityName>
<LocalAuthorityWebSite>sample string 29</LocalAuthorityWebSite>
<NewRatingPending>true</NewRatingPending>
<Phone>sample string 24</Phone>
<PostCode>sample string 6</PostCode>
<RatingDate>2024-04-29T13:51:31.0125714+01:00</RatingDate>
<RatingKey>sample string 25</RatingKey>
<RatingValue>sample string 10</RatingValue>
<RightToReply>sample string 31</RightToReply>
<SchemeType>sample string 13</SchemeType>
<geocode>
<latitude>1.1</latitude>
<longitude>1.1</longitude>
</geocode>
<scores>
<ConfidenceInManagement i:nil="true" />
<Hygiene i:nil="true" />
<Structural i:nil="true" />
</scores>
</establishment>
</establishments>
</EstablishmentDetailCollection>
application/x-www-form-urlencoded
Sample:
Currently Unsupported :(