LocationGroupOptionsViewModel

The options available for a location group in the data set.

Properties

Property	Type	Required	Description
level	GeographicLevelViewModel	true	The geographic level of the locations in this group.
options	array (one of: LocationCodedOptionViewModel LocationLocalAuthorityOptionViewModel LocationProviderOptionViewModel LocationRscRegionOptionViewModel LocationSchoolOptionViewModel )	true	The locations belonging to this level.

Example schema

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