DataSetPaginatedListViewModel

A paginated list of data sets.

Properties

Property	Type	Required	Description
paging	PagingViewModel	true	Provides metadata for use in pagination.
results	array (DataSetViewModel)	true	The list of results for this page.

Example schema

{
  "paging": {
    "page": 1,
    "pageSize": 20,
    "totalResults": 60,
    "totalPages": 3
  },
  "results": [
    {
      "id": "7588c2d6-9e8a-4d84-8f19-6b8d52a01fbd",
      "title": "Absence rates by geographic level",
      "summary": "Absence information for all enrolments in schools.",
      "status": "Published",
      "latestVersion": {
        "version": "2.0",
        "published": "2024-03-01T09:30:00+00:00",
        "totalResults": 1000000,
        "file": {
          "id": "e0754872-3206-4918-aad4-029eaaae191f"
        },
        "timePeriods": {
          "start": "2024 January",
          "end": "2024 December"
        },
        "geographicLevels": [
          "NAT",
          "REG",
          "LA"
        ],
        "filters": [
          "Characteristic",
          "School type"
        ],
        "indicators": [
          "string"
        ]
      },
      "supersedingDataSetId": "string(uuid)"
    }
  ]
}