Food Hygiene Rating API Version 2 Resource Detail

GET SortOptions

Returns details of all SortOptions, results are unbound.

Request Information

Request body formats

application/json, text/json

Sample: 
{
  "sortOptions": [
    {
      "sortOptionId": 1,
      "sortOptionName": "sample string 2",
      "sortOptionKey": "sample string 3",
      "links": [
        {
          "rel": "sample string 1",
          "href": "sample string 2"
        },
        {
          "rel": "sample string 1",
          "href": "sample string 2"
        }
      ]
    },
    {
      "sortOptionId": 1,
      "sortOptionName": "sample string 2",
      "sortOptionKey": "sample string 3",
      "links": [
        {
          "rel": "sample string 1",
          "href": "sample string 2"
        },
        {
          "rel": "sample string 1",
          "href": "sample string 2"
        }
      ]
    }
  ],
  "meta": {
    "dataSource": "sample string 1",
    "extractDate": "2025-11-17T03:46:40.5945836+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: 
<SortOptionCollection 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>2025-11-17T03:46:40.5945836+00:00</extractDate>
    <itemCount>3</itemCount>
    <pageNumber>8</pageNumber>
    <pageSize>7</pageSize>
    <returncode>sample string 4</returncode>
    <totalCount>5</totalCount>
    <totalPages>6</totalPages>
  </meta>
  <sortOptions>
    <sortOption>
      <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>
      <sortOptionId>1</sortOptionId>
      <sortOptionKey>sample string 3</sortOptionKey>
      <sortOptionName>sample string 2</sortOptionName>
    </sortOption>
    <sortOption>
      <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>
      <sortOptionId>1</sortOptionId>
      <sortOptionKey>sample string 3</sortOptionKey>
      <sortOptionName>sample string 2</sortOptionName>
    </sortOption>
  </sortOptions>
</SortOptionCollection>

application/x-www-form-urlencoded

Sample:

Sample not available.

Test API
URI parameters
=
Headers | Add header
: Delete
Body
Samples:
Status
Headers
Body