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

GET

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.
population-type path

Responses

200: area types returned successfully

Example value
{
  "count": 0,
  "items": [
    {
      "description": "National code definition for Census 2021",
      "hierarchy_order": "1200",
      "id": "NATCD",
      "label": "National code",
      "total_count": "2"
    }
  ],
  "limit": 0,
  "offset": 0,
  "total_count": 0
}

401: The token provided is unauthorised to carry out this operation

404: Dataset not found

Example value
{
  "errors": [
    "string"
  ]
}

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

502: Failed to process the request due to an error in a downstream server