/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
{
  "description": "The response body containing all available population-types for Census 2021",
  "properties": {
    "count": {
      "description": "The number of population-types",
      "type": "integer",
      "readOnly": true
    },
    "items": {
      "description": "An array of population-types",
      "type": "array",
      "items": {
        "description": "A population type which census data can be retrieved from",
        "type": "object",
        "properties": {
          "name": {
            "description": "The name of the population type",
            "type": "string",
            "example": "Usual-Residents"
          }
        }
      }
    },
    "limit": {
      "description": "The number of population-type requested",
      "type": "integer"
    },
    "offset": {
      "description": "The first row of population-types to retrieve, starting at 0. Use this parameter as a pagination mechanism along with the limit parameter",
      "type": "integer"
    },
    "total_count": {
      "description": "The total number of population-types",
      "type": "integer",
      "readOnly": true
    }
  }
}

401: Unauthorised to fetch

Example value
null

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

Example value
null