/code-lists
GET
Get a set of code lists containing information about dimensions which are used for all datasets at the ONS
Parameters
Name | Type | Description |
---|---|---|
limit | query | Maximum number of items that will be returned. A value of zero will return zero items. The default value is 20 and the maximum allowed is 1000. |
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: A Json message containing a set of code lists
Example value
{
"type": "object",
"properties": {
"count": {
"description": "The number of results returned in this response",
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"editions": {
"type": "object",
"properties": {
"href": {
"description": "The URL to the resource",
"type": "string"
}
}
},
"self": {
"type": "object",
"properties": {
"href": {
"description": "The URL to the resource",
"type": "string"
},
"id": {
"description": "The id of the resource",
"type": "string"
}
}
}
}
}
}
}
},
"limit": {
"description": "The limit applied to the number of results returned",
"type": "string"
},
"offset": {
"description": "The offset applied to the number of results returned",
"type": "string"
},
"total_count": {
"description": "The total number of results available",
"type": "string"
}
}
}
404: Code lists not found
Example value
null
500: Failed to process the request due to an internal error
Example value
null