DataSetQueryPaginatedResultsViewModel
A paginated list of results from a data set query.
Properties
Property | Type | Required | Description |
---|---|---|---|
paging |
PagingViewModel | true |
Provides metadata for use in pagination. |
results |
array (DataSetQueryResultViewModel) | true |
The list of results for this page. |
warnings |
array (WarningViewModel) | true |
A list of warnings, highlighting any potential issues with the request. |
Example schema
{
"paging": {
"page": 1,
"pageSize": 20,
"totalResults": 60,
"totalPages": 3
},
"results": [
{
"timePeriod": {
"code": "AYQ1",
"period": "2020/2021"
},
"geographicLevel": "NAT",
"locations": {
"NAT": "04bTr",
"REG": "4veOu",
"LA": "owqlK"
},
"filters": {
"ups2K": "n0WqP",
"j51wV": "AnZsi",
"hAkBQ": "dvB4z"
},
"values": {
"wLcft": "23593018",
"4S8Ou": "50.342",
"9kVFg": "25369172"
}
}
],
"warnings": [
{
"message": "There are no results.",
"path": "results",
"code": "NoResults",
"detail": {
"total": 0
}
}
]
}