DataSetMetaViewModel

All the metadata associated with a data set.

Properties

Property	Type	Required	Description
filters	array (FilterOptionsViewModel)	true	All the filters associated with the data set.
indicators	array (IndicatorViewModel)	true	All the indicators associated with the data set.
geographicLevels	array (GeographicLevelViewModel)	true	All the geographic levels associated with the data set.
locations	array (LocationGroupOptionsViewModel)	true	All the locations associated with the data set, grouped by geographic level.
timePeriods	array (TimePeriodOptionViewModel)	true	All the time periods associated with the data set.

Example schema

{
  "filters": [
    {
      "id": "BRlj4",
      "column": "school_type",
      "label": "School type",
      "hint": "Additional detail about the filter.",
      "options": [
        {
          "id": "q1g3J",
          "label": "State-funded primary",
          "isAggregate": true
        }
      ]
    }
  ],
  "indicators": [
    {
      "id": "enW68",
      "column": "sess_authorised",
      "label": "Percentage of authorised sessions",
      "unit": "string",
      "decimalPlaces": 2
    }
  ],
  "geographicLevels": [
    {
      "code": "NAT",
      "label": "National"
    }
  ],
  "locations": [
    {
      "level": {
        "code": "NAT",
        "label": "National"
      },
      "options": [
        {
          "id": "bOmZ4",
          "label": "Sheffield",
          "code": "E12000003"
        },
        {
          "id": "bOmZ4",
          "label": "Sheffield",
          "code": "E08000019",
          "oldCode": "373"
        },
        {
          "id": "bOmZ4",
          "label": "Sheffield",
          "ukprn": "12345678"
        },
        {
          "id": "bOmZ4",
          "label": "Sheffield"
        },
        {
          "id": "bOmZ4",
          "label": "Sheffield",
          "urn": "123456",
          "laEstab": "1234567"
        }
      ]
    }
  ],
  "timePeriods": [
    {
      "code": "AYQ1",
      "period": "2020/2021",
      "label": "2020/21 Q1"
    }
  ]
}