Skip to content

JSON data format

Minh Truong edited this page Mar 21, 2021 · 3 revisions

Here is datasheet to write country.json (rename this like finland.json) database file in src/data/countries directory.

Syntax

[
    {
        "band": 20,
        "providers": [
            {
                "provider": {
                    "name": "Vodafone",
                    "longName": "Vodafone UK",
                    "homePage": "https://www.vodafone.co.uk",
                    "backgroundColor": "#e60000",
                    "textColor": "white"
                },
                "frequency": {
                    "arfcn": [
                        6300
                    ],
                    "downLink": {
                        "start": 801,
                        "end": 811
                    },
                    "upLink": {
                        "start": 842,
                        "end": 852
                    }
                },
                "Valid":  {
                   "start": "2020-01-01",
                   "end": "2020-01-01"
                },
                "technology": [
                    "LTE"
                ],
                "source": [
                    {
                        "name": "Ofcom Spectrum Map",
                        "url": "https://static.ofcom.org.uk/static/spectrum/map.html"
                    }
                ]
            }
        ]
    }
]

Properties

Band

Properties Type Example Required
band Number 20 Yes
providers Array of provider [] Yes

Provider

Properties Type Example Value Required
name String Vodafone Yes
longName String Vodafone UK Yes
homePage String https://vodafone.co.uk Yes
backgroundColor String #e60000 Yes
textColor String white Yes
valid Object {"start": "2020-01-01", "end": "2020-01-01" } Optional
frequency Array of frequency [] Yes
technology Array of technology [] Optional
source Array of source [] Yes
  • textColor and backgroundColor accept values colors in hexdecimal and string.
  • In valid Object the start and end must use standard #RFC3339 format, example 2020-01-01.

Frequency

Properties Type Example Value Required
downLink Object {"start": 801, "end": 811} Conditional
upLink Object {"start": 842, "end": 852} Conditional
arfcn Array [6300] Optional
  • On FDD band downLink and upLink both required. The values must be Number.
  • On TDD and SDL bands downLink only required. The value must be Number.
  • On SUL band upLink only required. The value must be Number.

Technology

List of technologies in Array

["LTE", "NR"]

Allowed Values:

  • NR
  • LTE
  • UMTS
  • GSM
  • CDMA
  • Wimax
  • Not used

Source

We recommend use regulator or provider websites as source of data. The link must have details about spectrum allocation. You can add multiple sources here. Please prefer English version of source's.

Properties Type Example Value Required
name String Ofcom Spectrum Map First value
url String https://static.ofcom.org.uk/static/spectrum/map.html First value
  • One source required, multiple optional
Clone this wiki locally