🌈 The EM27 Retrieval Pipeline 1.0.0 has been released
⚙️ API Reference
Metadata

Metadata

locations.json

Example File

[
    {
        "location_id": "lid1",
        "details": "description of location 1",
        "lon": 10.5,
        "lat": 48.1,
        "alt": 500.0
    },
    {
        "location_id": "lid2",
        "details": "description of location 2",
        "lon": 11.3,
        "lat": 48.0,
        "alt": 600.0
    }
]

Schema definition

root*(array)
#(object)
additional properties allowed: false
location_id*(string)
Your internal location ID identifying a specific location. Allowed values: letters, numbers, dashes, underscores.
min. length: 1
max. length: 128
regex pattern: "^[a-zA-Z0-9_-]+$"
details(string)
min. length: 0
default: ""
lon*(number)
min.: -180
max.: 180
lat*(number)
min.: -90
max.: 90
alt*(number)
min.: -20
max.: 10000

sensors.json

Example File

[
    {
        "sensor_id": "sid1",
        "serial_number": 50,
        "setups": [
            {
                "from_datetime": "2020-08-22T00:00:00+00:00",
                "to_datetime": "2020-08-25T23:59:59+00:00",
                "value": {
                    "location_id": "lid1",
                    "pressure_data_source": "LMU-MIM01-height-adjusted",
                    "utc_offset": 2.0,
                    "atmospheric_profile_location_id": "lid2"
                }
            },
            {
                "from_datetime": "2020-08-26T00:00:00+00:00",
                "to_datetime": "2020-08-30T23:59:59+00:00",
                "value": {
                    "location_id": "lid1",
                    "pressure_data_source": "LMU-MIM01-height-adjusted",
                    "utc_offset": 2.0,
                    "atmospheric_profile_location_id": null
                }
            },
            {
                "from_datetime": "2020-08-31T00:00:00+00:00",
                "to_datetime": "2020-09-26T23:59:59+00:00",
                "value": {
                    "location_id": "lid1",
                    "pressure_data_source": null,
                    "utc_offset": 2.0,
                    "atmospheric_profile_location_id": null
                }
            },
            {
                "from_datetime": "2020-09-27T00:00:00+00:00",
                "to_datetime": "2020-10-01T23:59:59+00:00",
                "value": {
                    "location_id": "lid2",
                    "pressure_data_source": null,
                    "utc_offset": 0.0,
                    "atmospheric_profile_location_id": null
                }
            }
        ]
    },
    {
        "sensor_id": "sid2",
        "serial_number": 51,
        "setups": [
            {
                "from_datetime": "2020-08-26T00:00:00+00:00",
                "to_datetime": "2020-10-01T23:59:59+00:00",
                "value": {
                    "location_id": "lid1",
                    "pressure_data_source": null,
                    "utc_offset": 0.0,
                    "atmospheric_profile_location_id": null
                }
            }
        ]
    }
]

Schema definition

root*(array)
#(object)
Metadata for a single sensor.
additional properties allowed: false
sensor_id*(string)
Your internal sensor ID identifying a specific EM27/SUN (system). Allowed characters: letters, numbers, dashes, underscores.
min. length: 1
max. length: 128
regex pattern: "^[a-zA-Z0-9_-]+$"
serial_number*(integer)
Serial number of the EM27/SUN
min.: 1
setups*(array)
#(object)
An element in the `sensor.setups` list
additional properties allowed: false
from_datetime*(string)
to_datetime*(string)
value*(object)
additional properties allowed: false
location_id*(string)
Location ID referring to a location named in `locations.json`
min. length: 1
pressure_data_source*(union)
Pressure data source, if not set, using the pressure of the sensor
default: null
option 1(string)
min. length: 1
option 2(null)
utc_offset(number)
UTC offset of the location, if not set, using an offset of 0
default: 0
atmospheric_profile_location_id*(union)
Location ID referring to a location named in `locations.json`. This location's coordinates are used for the atmospheric profiles in the retrieval.
default: null
option 1(string)
min. length: 1
option 2(null)

campaigns.json

Example File

[
    {
        "from_datetime": "2019-09-13T00:00:00+00:00",
        "to_datetime": "2100-01-01T23:59:59+00:00",
        "campaign_id": "cid1",
        "sensor_ids": [
            "sid1",
            "sid2"
        ],
        "location_ids": [
            "lid1",
            "lid2"
        ]
    }
]

Schema definition

root*(array)
default: []
#(object)
additional properties allowed: false
from_datetime*(string)
to_datetime*(string)
campaign_id*(string)
Your internal sensor ID identifying a specific campaign. Allowed values: letters, numbers, dashes, underscores.
min. length: 1
max. length: 128
regex pattern: "^[a-zA-Z0-9_-]+$"
sensor_ids*(array)
#(string)
location_ids*(array)
#(string)