API responses - Xweather Protect, Xweather Optimize, Xweather Observe

Vaisala Xweather Protect, Xweather Optimize, and Xweather Observe Forecast by Geometry API Reference

Product status
Document code
M213289EN
Revision
B
ft:locale
en-US
Product
Xweather Protect, Xweather Optimize, Xweather Observe
Document type
Technical description

The API returns the following responses.

API responses
Response Description
200 OK.
400 Bad request.
401 Unauthorized. An API key was not provided.
403 Forbidden. The API key is not valid.
404 The service could not be reached.
500 Internal server error.

Schema for response 200

The example shows a response with one feature parameter.

Example

{
  "meta": {
    "time_zone": "Europe/Helsinki"
  },
  "geometry": {
    "type": "Point",
    "coordinates": [
      125.6,
      10.1,
      836
    ]
  },
  "features": [
    {
      "accumulatedPrecipitation": {
        "probability": "",
        "aggregation": "",
        "level": "",
        "unit": "C",
        "elevation": 0,
        "timeSeries": [
          {
            "startDatetime": "2022-10-20T16:15:03-05:00",
            "endDatetime": "2022-10-20T16:15:03-05:00",
            "recurring": "hourly",
            "valuesType": "float",
            "values": [
              24.1,
              26.4
            ]
          }
        ]
      },
      "airQualityIndex": {
        "probability": "",
        "aggregation": "",
        "level": "",
        "unit": "C",
        "elevation": 0,
        "timeSeries": [
          {
            "startDatetime": "2022-10-20T16:15:03-05:00",
            "endDatetime": "2022-10-20T16:15:03-05:00",
            "recurring": "hourly",
            "valuesType": "float",
            "values": [
              24.1,
              26.4
            ]
          }
        ]
      },
      "airTemperature": {
        "probability": "",
        "aggregation": "",
        "level": "",
        "unit": "C",
        "elevation": 0,
        "timeSeries": [
          {
            "startDatetime": "2022-10-20T16:15:03-05:00",
            "endDatetime": "2022-10-20T16:15:03-05:00",
            "recurring": "hourly",
            "valuesType": "float",
            "values": [
              24.1,
              26.4
            ]
          }
        ]
      },
      "airTemperatureMax": {
        "probability": "",
        "aggregation": "",
        "level": "",
        "unit": "C",
        "elevation": 0,
        "timeSeries": [
          {
            "startDatetime": "2022-10-20T16:15:03-05:00",
            "endDatetime": "2022-10-20T16:15:03-05:00",
            "recurring": "hourly",
            "valuesType": "float",
            "values": [
              24.1,
              26.4
            ]
          }
        ]
      },
      "airTemperatureMin": {
        "probability": "",
        "aggregation": "",
        "level": "",
        "unit": "C",
        "elevation": 0,
        "timeSeries": [
          {
            "startDatetime": "2022-10-20T16:15:03-05:00",
            "endDatetime": "2022-10-20T16:15:03-05:00",
            "recurring": "hourly",
            "valuesType": "float",
            "values": [
              24.1,
              26.4
            ]
          }
        ]
      },
      "airPressure": {
        "probability": "",
        "aggregation": "",
        "level": "",
        "unit": "C",
        "elevation": 0,
        "timeSeries": [
          {
            "startDatetime": "2022-10-20T16:15:03-05:00",
            "endDatetime": "2022-10-20T16:15:03-05:00",
            "recurring": "hourly",
            "valuesType": "float",
            "values": [
              24.1,
              26.4
            ]
          }
        ]
      },
      "carbonMonoxide": {
        "probability": "",
        "aggregation": "",
        "level": "",
        "unit": "C",
        "elevation": 0,
        "timeSeries": [
          {
            "startDatetime": "2022-10-20T16:15:03-05:00",
            "endDatetime": "2022-10-20T16:15:03-05:00",
            "recurring": "hourly",
            "valuesType": "float",
            "values": [
              24.1,
              26.4
            ]
          }
        ]
      },
      "feelingTemperature": {
        "probability": "",
        "aggregation": "",
        "level": "",
        "unit": "C",
        "elevation": 0,
        "timeSeries": [
          {
            "startDatetime": "2022-10-20T16:15:03-05:00",
            "endDatetime": "2022-10-20T16:15:03-05:00",
            "recurring": "hourly",
            "valuesType": "float",
            "values": [
              24.1,
              26.4
            ]
          }
        ]
      },
      "healthIndex": {
        "probability": "",
        "aggregation": "",
        "level": "",
        "unit": "C",
        "elevation": 0,
        "timeSeries": [
          {
            "startDatetime": "2022-10-20T16:15:03-05:00",
            "endDatetime": "2022-10-20T16:15:03-05:00",
            "recurring": "hourly",
            "valuesType": "float",
            "values": [
              24.1,
              26.4
            ]
          }
        ]
      },
      "nitrogenDioxide": {
        "probability": "",
        "aggregation": "",
        "level": "",
        "unit": "C",
        "elevation": 0,
        "timeSeries": [
          {
            "startDatetime": "2022-10-20T16:15:03-05:00",
            "endDatetime": "2022-10-20T16:15:03-05:00",
            "recurring": "hourly",
            "valuesType": "float",
            "values": [
              24.1,
              26.4
            ]
          }
        ]
      },
      "ozone": {
        "probability": "",
        "aggregation": "",
        "level": "",
        "unit": "C",
        "elevation": 0,
        "timeSeries": [
          {
            "startDatetime": "2022-10-20T16:15:03-05:00",
            "endDatetime": "2022-10-20T16:15:03-05:00",
            "recurring": "hourly",
            "valuesType": "float",
            "values": [
              24.1,
              26.4
            ]
          }
        ]
      },
      "particleMatter25": {
        "probability": "",
        "aggregation": "",
        "level": "",
        "unit": "C",
        "elevation": 0,
        "timeSeries": [
          {
            "startDatetime": "2022-10-20T16:15:03-05:00",
            "endDatetime": "2022-10-20T16:15:03-05:00",
            "recurring": "hourly",
            "valuesType": "float",
            "values": [
              24.1,
              26.4
            ]
          }
        ]
      },
      "particleMatter10": {
        "probability": "",
        "aggregation": "",
        "level": "",
        "unit": "C",
        "elevation": 0,
        "timeSeries": [
          {
            "startDatetime": "2022-10-20T16:15:03-05:00",
            "endDatetime": "2022-10-20T16:15:03-05:00",
            "recurring": "hourly",
            "valuesType": "float",
            "values": [
              24.1,
              26.4
            ]
          }
        ]
      },
      "probabilityPrecipitation": {
        "probability": "",
        "aggregation": "",
        "level": "",
        "unit": "C",
        "elevation": 0,
        "timeSeries": [
          {
            "startDatetime": "2022-10-20T16:15:03-05:00",
            "endDatetime": "2022-10-20T16:15:03-05:00",
            "recurring": "hourly",
            "valuesType": "float",
            "values": [
              24.1,
              26.4
            ]
          }
        ]
      },
      "relativeHumidity": {
        "probability": "",
        "aggregation": "",
        "level": "",
        "unit": "C",
        "elevation": 0,
        "timeSeries": [
          {
            "startDatetime": "2022-10-20T16:15:03-05:00",
            "endDatetime": "2022-10-20T16:15:03-05:00",
            "recurring": "hourly",
            "valuesType": "float",
            "values": [
              24.1,
              26.4
            ]
          }
        ]
      },
      "solarRadiation": {
        "probability": "",
        "aggregation": "",
        "level": "",
        "unit": "C",
        "elevation": 0,
        "timeSeries": [
          {
            "startDatetime": "2022-10-20T16:15:03-05:00",
            "endDatetime": "2022-10-20T16:15:03-05:00",
            "recurring": "hourly",
            "valuesType": "float",
            "values": [
              24.1,
              26.4
            ]
          }
        ]
      },
      "sulfurDioxide": {
        "probability": "",
        "aggregation": "",
        "level": "",
        "unit": "C",
        "elevation": 0,
        "timeSeries": [
          {
            "startDatetime": "2022-10-20T16:15:03-05:00",
            "endDatetime": "2022-10-20T16:15:03-05:00",
            "recurring": "hourly",
            "valuesType": "float",
            "values": [
              24.1,
              26.4
            ]
          }
        ]
      },
      "uvIndex": {
        "probability": "",
        "aggregation": "",
        "level": "",
        "unit": "C",
        "elevation": 0,
        "timeSeries": [
          {
            "startDatetime": "2022-10-20T16:15:03-05:00",
            "endDatetime": "2022-10-20T16:15:03-05:00",
            "recurring": "hourly",
            "valuesType": "float",
            "values": [
              24.1,
              26.4
            ]
          }
        ]
      },
      "windDirection": {
        "probability": "",
        "aggregation": "",
        "level": "",
        "unit": "C",
        "elevation": 0,
        "timeSeries": [
          {
            "startDatetime": "2022-10-20T16:15:03-05:00",
            "endDatetime": "2022-10-20T16:15:03-05:00",
            "recurring": "hourly",
            "valuesType": "float",
            "values": [
              24.1,
              26.4
            ]
          }
        ]
      },
      "windSpeed": {
        "probability": "",
        "aggregation": "",
        "level": "",
        "unit": "C",
        "elevation": 0,
        "timeSeries": [
          {
            "startDatetime": "2022-10-20T16:15:03-05:00",
            "endDatetime": "2022-10-20T16:15:03-05:00",
            "recurring": "hourly",
            "valuesType": "float",
            "values": [
              24.1,
              26.4
            ]
          }
        ]
      },
      "windSpeedMax": {
        "probability": "",
        "aggregation": "",
        "level": "",
        "unit": "C",
        "elevation": 0,
        "timeSeries": [
          {
            "startDatetime": "2022-10-20T16:15:03-05:00",
            "endDatetime": "2022-10-20T16:15:03-05:00",
            "recurring": "hourly",
            "valuesType": "float",
            "values": [
              24.1,
              26.4
            ]
          }
        ]
      }
    }
  ]
}