Food Hygiene Rating API Version 2 Resource Detail
GET Regions/basic/{pageNumber}/{pageSize}
Returns a basic list of regions, details can be retrieved by calling regions{id}, page parameters allow for page number and size specification.
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| pageNumber | The page number. |
Define this parameter in the request URI. |
| pageSize | Size of the page. |
Define this parameter in the request URI. |
Request body formats
application/json, text/json
Sample:
{
"regions": [
{
"id": 1,
"name": "sample string 2",
"nameKey": "sample string 3",
"code": "sample string 4",
"links": [
{
"rel": "sample string 1",
"href": "sample string 2"
},
{
"rel": "sample string 1",
"href": "sample string 2"
}
]
},
{
"id": 1,
"name": "sample string 2",
"nameKey": "sample string 3",
"code": "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-04T08:19:16.6690716+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:
<RegionCollection 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:19:16.6690716+00:00</extractDate>
<itemCount>3</itemCount>
<pageNumber>8</pageNumber>
<pageSize>7</pageSize>
<returncode>sample string 4</returncode>
<totalCount>5</totalCount>
<totalPages>6</totalPages>
</meta>
<regions>
<region>
<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>
<code>sample string 4</code>
<id>1</id>
<name>sample string 2</name>
<nameKey>sample string 3</nameKey>
</region>
<region>
<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>
<code>sample string 4</code>
<id>1</id>
<name>sample string 2</name>
<nameKey>sample string 3</nameKey>
</region>
</regions>
</RegionCollection>
application/x-www-form-urlencoded
Sample:
Currently Unsupported :(