DataSetVersionPaginatedListViewModel

A paginated list of data set versions.

Properties

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

Example schema

{
  "paging": {
    "page": 1,
    "pageSize": 20,
    "totalResults": 60,
    "totalPages": 3
  },
  "results": [
    {
      "version": "1.0",
      "type": "Major",
      "status": "Published",
      "published": "2024-03-01T09:30:00+00:00",
      "withdrawn": "2024-06-01T12:00:00+00:00",
      "notes": "Some notes about the version.",
      "totalResults": 1000000,
      "file": {
        "id": "e0754872-3206-4918-aad4-029eaaae191f"
      },
      "release": {
        "title": "Spring term 2023/24",
        "slug": "2023-24-spring-term"
      },
      "timePeriods": {
        "start": "2024 January",
        "end": "2024 December"
      },
      "geographicLevels": [
        "National",
        "Regional",
        "Local authority"
      ],
      "filters": [
        "Characteristic",
        "School type"
      ],
      "indicators": [
        "Authorised absence rate",
        "Overall absence rate"
      ]
    }
  ]
}