DataSetVersionViewModel

Provides high-level information about a data set version.

Properties

Property	Type	Required	Description
`version`	string	true	The version number. Follows semantic versioning e.g. 2.0 (major), 1.1 (minor).
`type`	DataSetVersionType	true	The version type. Can be one of the following: `Major` - backwards incompatible changes are being introduced `Minor` - backwards compatible changes are being introduced Major versions typically indicate that some action may be required to ensure code that consumes the data set continues to work. Minor versions should not cause issues in the functionality of existing code.
`status`	DataSetVersionStatus	true	The version’s status. Can be one of the following: `Published` - the version is published and can be used `Deprecated` - the version is being deprecated and will not be usable in the future `Withdrawn` - the version has been withdrawn and can no longer be used
`published`	string	false	When the version was published.
`withdrawn`	string	false	When the version was withdrawn.
`notes`	string	true	Any notes about this version and its changes.
`totalResults`	integer	true	The total number of results available to query in the data set.
`file`	DataSetVersionFileViewModel	true	The file that this data set version is based on.
`release`	DataSetVersionReleaseViewModel	true	The statistical release that this version was published with.
`timePeriods`	TimePeriodRangeViewModel	true	The time period range covered by the data set.
`geographicLevels`	array (string)	true	The geographic levels available in the data set. Allowed options for child items: `English devolved area` `Local authority` `Local authority district` `Local enterprise partnership` `Local skills improvement plan area` `Institution` `Mayoral combined authority` `MAT` `National` `Opportunity area` `Parliamentary constituency` `Provider` `Regional` `RSC region` `School` `Sponsor` `Ward` `Planning area`
`filters`	array (string)	true	The filters available in the data set.
`indicators`	array (string)	true	The indicators available in the data set.

Example schema

{
  "version": "1.0",
  "type": "Major",
  "status": "Published",
  "published": "2024-03-01T09:30:00+00:00",
  "withdrawn": "string(date-time)",
  "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": [
    "NAT",
    "REG",
    "LA"
  ],
  "filters": [
    "Characteristic",
    "School type"
  ],
  "indicators": [
    "string"
  ]
}