Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagejson
{
  "timePeriodList": [
    {
      "EndDate": "Tue, 31 Mar 2020 00:00:00 GMT", 
      "StartDate": "Mon, 01 Jan 1900 00:00:00 GMT", 
      "TimePeriodID": 1, 
      "TimePeriodName": "To March 2020"
    },
    {
        "EndDate": "Sat, 31 Dec 2022 00:00:00 GMT",
        "StartDate": "Mon, 01 Jan 1900 00:00:00 GMT",
        "TimePeriodID": 9,
        "TimePeriodName": "To December 2022"
    },
    ...
  ]
}

...

...

*Proposed* /timePeriod/systemLevels

Returns all available time periods, with an array of the system levels included in the given time period.

Note: Inverse of “/area/systemLevel/timePeriods“

Code Block
languagejson
{
  "timePeriodList": [
    {
      "EndDate": "Tue, 31 Mar 2020 00:00:00 GMT", 
      "StartDate": "Mon, 01 Jan 1900 00:00:00 GMT", 
      "TimePeriodID": 1, 
      "TimePeriodName": "To March 2020",
      "SystemLevels": [
        {
          "SystemLevelID": 1,
          "SystemLevelName": "England",  
          "IsVisible": "Y",
          "NationalLevel": "Y"
        },
        {
          "SystemLevelID": 2,
          "SystemLevelName": "STP",  
          "IsVisible": "Y",
          "NationalLevel": "N"
        },
        ...
        }
      ]
    },
    ...
  ]
}

...

Area

/area/systemLevel

Returns all available system levels for a specified time period.

Query parameters:

  • timePeriodID - ID of time period for which to return system levels for. Available system levels in given time period are controlled by SystemLevelTimePeriod table (compulsory)

Code Block
languagejson
{
  "systemLevels": [
    {
      "IsVisible": "Y", 
      "NationalLevel": "Y", 
      "SystemLevelID": 1, 
      "SystemLevelName": "England", 
      "SystemLevelOrder": 1
    }, 
    {
      "IsVisible": "Y", 
      "NationalLevel": "N", 
      "SystemLevelID": 2, 
      "SystemLevelName": "STP", 
      "SystemLevelOrder": 2
    }
  ]
}

...

*Proposed*/area/systemLevel/timePeriods

Returns all available system levels for a specified time period.

Query parameters:

...

, with an array of the time periods where the system levels occur.

Note: Inverse of “/timePeriod/systemLevels”

Code Block
languagejson
{
  "systemLevels": [
    {
      "IsVisible": "Y", 
      "NationalLevel": "Y", 
      "SystemLevelID": 1, 
      "SystemLevelName": "England", 
      "SystemLevelOrder": 1
    }, 
    {
      "IsVisible": "Y", 
      "NationalLevel": "N", 
      "SystemLevelID": 2, 
      "SystemLevelName": "STP", 
      "SystemLevelOrder": 2
    }
  ]
}

...