/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
{
  "description": "The response body containing all available area-types for a given population-type",
  "properties": {
    "count": {
      "description": "The number of area-types returned",
      "type": "integer",
      "readOnly": true
    },
    "items": {
      "description": "An array of area-types",
      "type": "array",
      "items": {
        "properties": {
          "description": {
            "type": "string",
            "example": "National code definition for Census 2021"
          },
          "id": {
            "type": "string",
            "example": "NATCD"
          },
          "label": {
            "type": "string",
            "example": "National code"
          },
          "total_count": {
            "type": "integer",
            "example": "2"
          }
        }
      }
    },
    "limit": {
      "description": "The number of area-types requested",
      "type": "integer"
    },
    "offset": {
      "description": "The first row of area-types for 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 area-types",
      "type": "integer",
      "readOnly": true
    }
  }
}

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

Example value
null

404: Dataset not found

Example value
{
  "description": "The response body containing an error message",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

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

Example value
null

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

Example value
null