/population-types/{population-type}/dimensions
GET
Parameters
Name | Type | Description |
---|---|---|
population-type | path |
Responses
200: A json list containing non-geography base variables for a dataset
Example value
{
"description": "A list of dimensions",
"type": "object",
"properties": {
"count": {
"description": "The number of dimensions returned",
"type": "integer",
"readOnly": true
},
"items": {
"type": "array",
"items": {
"description": "The response body containing the information for a dimension",
"properties": {
"dimension": {
"properties": {
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"total_count": {
"type": "integer"
}
}
}
}
}
},
"limit": {
"description": "The number of dimensions requested",
"type": "integer"
},
"offset": {
"description": "The first row of dimensions 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 dimensions",
"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