DataSetVersionChangesViewModel

A set of changes made to a data set version.

Properties

Property	Type	Required	Description
majorChanges	ChangeSetViewModel	true	Any major changes that were made to the data set.
minorChanges	ChangeSetViewModel	true	Any minor changes that were made to the data set.

Example schema

{
  "majorChanges": {
    "filters": [
      {
        "currentState": {
          "id": "BRlj4",
          "column": "school_type",
          "label": "School type",
          "hint": "Additional detail about the filter."
        },
        "previousState": {
          "id": "BRlj4",
          "column": "school_type",
          "label": "School type",
          "hint": "Additional detail about the filter."
        }
      }
    ],
    "filterOptions": [
      {
        "filter": {
          "id": "BRlj4",
          "column": "school_type",
          "label": "School type",
          "hint": "Additional detail about the filter."
        },
        "options": [
          {
            "currentState": {
              "id": "q1g3J",
              "label": "State-funded primary",
              "isAggregate": true
            },
            "previousState": {
              "id": "q1g3J",
              "label": "State-funded primary",
              "isAggregate": true
            }
          }
        ]
      }
    ],
    "geographicLevels": [
      {
        "currentState": {
          "code": "NAT",
          "label": "National"
        },
        "previousState": {
          "code": "NAT",
          "label": "National"
        }
      }
    ],
    "indicators": [
      {
        "currentState": {
          "id": "enW68",
          "column": "sess_authorised",
          "label": "Percentage of authorised sessions",
          "unit": "%",
          "decimalPlaces": 2
        },
        "previousState": {
          "id": "enW68",
          "column": "sess_authorised",
          "label": "Percentage of authorised sessions",
          "unit": "%",
          "decimalPlaces": 2
        }
      }
    ],
    "locationGroups": [
      {
        "currentState": {
          "level": {
            "code": "NAT",
            "label": "National"
          }
        },
        "previousState": {
          "level": {
            "code": "NAT",
            "label": "National"
          }
        }
      }
    ],
    "locationOptions": [
      {
        "level": {
          "code": "NAT",
          "label": "National"
        },
        "options": [
          {
            "currentState": {
              "id": "bOmZ4",
              "label": "Sheffield",
              "code": "E12000003"
            },
            "previousState": {
              "id": "bOmZ4",
              "label": "Sheffield",
              "code": "E12000003"
            }
          }
        ]
      }
    ],
    "timePeriods": [
      {
        "currentState": {
          "code": "AYQ1",
          "period": "2020/2021",
          "label": "2020/21 Q1"
        },
        "previousState": {
          "code": "AYQ1",
          "period": "2020/2021",
          "label": "2020/21 Q1"
        }
      }
    ]
  },
  "minorChanges": {
    "filters": [
      {
        "currentState": {
          "id": "BRlj4",
          "column": "school_type",
          "label": "School type",
          "hint": "Additional detail about the filter."
        },
        "previousState": {
          "id": "BRlj4",
          "column": "school_type",
          "label": "School type",
          "hint": "Additional detail about the filter."
        }
      }
    ],
    "filterOptions": [
      {
        "filter": {
          "id": "BRlj4",
          "column": "school_type",
          "label": "School type",
          "hint": "Additional detail about the filter."
        },
        "options": [
          {
            "currentState": {
              "id": "q1g3J",
              "label": "State-funded primary",
              "isAggregate": true
            },
            "previousState": {
              "id": "q1g3J",
              "label": "State-funded primary",
              "isAggregate": true
            }
          }
        ]
      }
    ],
    "geographicLevels": [
      {
        "currentState": {
          "code": "NAT",
          "label": "National"
        },
        "previousState": {
          "code": "NAT",
          "label": "National"
        }
      }
    ],
    "indicators": [
      {
        "currentState": {
          "id": "enW68",
          "column": "sess_authorised",
          "label": "Percentage of authorised sessions",
          "unit": "%",
          "decimalPlaces": 2
        },
        "previousState": {
          "id": "enW68",
          "column": "sess_authorised",
          "label": "Percentage of authorised sessions",
          "unit": "%",
          "decimalPlaces": 2
        }
      }
    ],
    "locationGroups": [
      {
        "currentState": {
          "level": {
            "code": "NAT",
            "label": "National"
          }
        },
        "previousState": {
          "level": {
            "code": "NAT",
            "label": "National"
          }
        }
      }
    ],
    "locationOptions": [
      {
        "level": {
          "code": "NAT",
          "label": "National"
        },
        "options": [
          {
            "currentState": {
              "id": "bOmZ4",
              "label": "Sheffield",
              "code": "E12000003"
            },
            "previousState": {
              "id": "bOmZ4",
              "label": "Sheffield",
              "code": "E12000003"
            }
          }
        ]
      }
    ],
    "timePeriods": [
      {
        "currentState": {
          "code": "AYQ1",
          "period": "2020/2021",
          "label": "2020/21 Q1"
        },
        "previousState": {
          "code": "AYQ1",
          "period": "2020/2021",
          "label": "2020/21 Q1"
        }
      }
    ]
  }
}