Food Hygiene Rating API Version 2 Resource Detail
GET ScoreDescriptors?establishmentId={establishmentId}
Returns details of all scoreDescriptor, results are unbound.
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| establishmentId | No documentation available. |
Define this parameter in the request URI. |
Request body formats
application/json, text/json
Sample:
{
"scoreDescriptors": [
{
"Id": 1,
"ScoreCategory": "sample string 2",
"Score": 3,
"Description": "sample string 4",
"links": [
{
"rel": "sample string 1",
"href": "sample string 2"
},
{
"rel": "sample string 1",
"href": "sample string 2"
}
]
},
{
"Id": 1,
"ScoreCategory": "sample string 2",
"Score": 3,
"Description": "sample string 4",
"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-11T21:17:20.0092264+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:
<ScoreDescriptorsCollection 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-11T21:17:20.0092264+00:00</extractDate>
<itemCount>3</itemCount>
<pageNumber>8</pageNumber>
<pageSize>7</pageSize>
<returncode>sample string 4</returncode>
<totalCount>5</totalCount>
<totalPages>6</totalPages>
</meta>
<scoreDescriptors>
<scoreDescriptors>
<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>
<Description>sample string 4</Description>
<Id>1</Id>
<Score>3</Score>
<ScoreCategory>sample string 2</ScoreCategory>
</scoreDescriptors>
<scoreDescriptors>
<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>
<Description>sample string 4</Description>
<Id>1</Id>
<Score>3</Score>
<ScoreCategory>sample string 2</ScoreCategory>
</scoreDescriptors>
</scoreDescriptors>
</ScoreDescriptorsCollection>
application/x-www-form-urlencoded
Sample:
Currently Unsupported :(