Food Hygiene Rating API Version 2 Resource Detail
GET Ratings
Returns details of all ratings, results are unbound.
Request Information
Request body formats
application/json, text/json
Sample:
{ "ratings": [ { "ratingId": 1, "ratingName": "sample string 2", "ratingKey": "sample string 3", "ratingKeyName": "sample string 4", "schemeTypeId": 5, "links": [ { "rel": "sample string 1", "href": "sample string 2" }, { "rel": "sample string 1", "href": "sample string 2" } ] }, { "ratingId": 1, "ratingName": "sample string 2", "ratingKey": "sample string 3", "ratingKeyName": "sample string 4", "schemeTypeId": 5, "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:42:09.8335165+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:
<RatingCollection 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:42:09.8335165+00:00</extractDate> <itemCount>3</itemCount> <pageNumber>8</pageNumber> <pageSize>7</pageSize> <returncode>sample string 4</returncode> <totalCount>5</totalCount> <totalPages>6</totalPages> </meta> <ratings> <rating> <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> <ratingId>1</ratingId> <ratingKey>sample string 3</ratingKey> <ratingKeyName>sample string 4</ratingKeyName> <ratingName>sample string 2</ratingName> <schemeTypeId>5</schemeTypeId> </rating> <rating> <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> <ratingId>1</ratingId> <ratingKey>sample string 3</ratingKey> <ratingKeyName>sample string 4</ratingKeyName> <ratingName>sample string 2</ratingName> <schemeTypeId>5</schemeTypeId> </rating> </ratings> </RatingCollection>
application/x-www-form-urlencoded
Sample:
Currently Unsupported :(