/population-types

GET

Retrieves a list of population types for Census

Parameters

Name Type Description
limit query Limit the number of items that will be returned. Defaults to 20 and capped at 500
offset query 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.

Responses

200: Json object containing a list of population types for Census

Example value
{
  "count": 0,
  "items": [
    {
      "description": "All usual residents",
      "label": "All usual residents",
      "name": "Usual-Residents"
    }
  ],
  "limit": 0,
  "offset": 0,
  "total_count": 0
}

401: Unauthorised to fetch

500: Failed to process the request due to an internal error