ChangeSetViewModel

A set of changes grouped by their type (major or minor).

Properties

Property	Type	Required	Description
filters	array (FilterChangeViewModel)	false	A list of any filter changes made to the data set.
filterOptions	array (FilterOptionChangesViewModel)	false	A list of any filter option changes made to the data set.
geographicLevels	array (GeographicLevelChangeViewModel)	false	A list of any geographic level changes made to the data set.
indicators	array (IndicatorChangeViewModel)	false	A list of any indicator changes made to the data set.
locationGroups	array (LocationGroupChangeViewModel)	false	A list of any location group changes made to the data set.
locationOptions	array (LocationOptionChangesViewModel)	false	A list of any location option changes made to the data set.
timePeriods	array (TimePeriodOptionChangeViewModel)	false	A list of any time period changes made to the data set.

Example schema

{
  "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"
      }
    }
  ]
}