/population-types/{population-type}/area-types/{area-type}/areas
GET
Parameters
Name | Type | Description |
---|---|---|
population-type | path | |
area-type | path | |
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: Categories for area type returned
Example value
{
"description": "The response body containing the information for an area",
"properties": {
"count": {
"description": "The number of areas",
"type": "integer",
"readOnly": true
},
"items": {
"description": "An array of areas",
"type": "array",
"items": {
"properties": {
"area-type": {
"type": "string",
"example": "LADCD"
},
"id": {
"type": "string",
"example": "E06000001"
},
"label": {
"type": "string",
"example": "Hartlepool"
}
}
}
},
"limit": {
"description": "The number of areas requested",
"type": "integer"
},
"offset": {
"description": "The first row of areas 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 areas",
"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