OFoffice-of-national-statistics

Get list of area types for given population type

get/population-types/{population-type}/area-types

Request

  • Base URL
    /v1 (relative, and the document’s source URL is not known)
  • Auth
    none declared

Path parameters

population-typestring required

Query parameters

limitinteger

Limit the number of items that will be returned. Defaults to 20 and capped at 500

offsetinteger

Starting index of the items array that will be returned. By default it is zero, meaning that the returned items will start from the beginning.

Response

area types returned successfully

countinteger

The number of area-types returned

limitinteger

The number of area-types requested

offsetinteger

The first row of area-types for to retrieve, starting at 0. Use this parameter as a pagination mechanism along with the limit parameter

total_countinteger

The total number of area-types

Example response

{
  "items": [
    {
      "id": "NATCD",
      "label": "National code",
      "description": "National code definition for Census 2021"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.