{
"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"
},
"hierarchy_order": {
"type": "integer",
"example": "1200"
},
"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
}
}
}
{
"description": "The response body containing an error message",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "string"
}
}
}
}