OFoffice-of-national-statistics
Public

Get all population types relevant to Census

Retrieves a list of population types for Census

get/population-types

Request

  • Base URL
    /v1 (relative, and the document’s source URL is not known)
  • Auth
    API key in header internal-token

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

Json object containing a list of population types for Census

countinteger

The number of population-types

limitinteger

The number of population-type requested

offsetinteger

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

total_countinteger

The total number of population-types

Example response

{
  "items": [
    {
      "name": "Usual-Residents",
      "label": "All usual residents",
      "description": "All usual residents"
    }
  ]
}

Changes

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