API responses - Xweather Insight

Vaisala Xweather Protect and Xweather Optimize Xcast by Site ID API Reference

Product status
Document code
M213290EN
Revision
B
ft:locale
en-US
Product
Xweather Insight
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

Example

{
  "meta": {
    "site_id": "urn:dev:ops:16961-CXT530-S1234567",
    "time_zone": "UTC"
  },
  "geometry": {
    "type": "Point",
    "coordinates": [
      125.6,
      10.1,
      836
    ]
  },
  "features": [
    {
      "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
            ],
            "percentiles": {
              "p5": [
                125.6,
                10.1,
                836
              ],
              "p10": [
                125.6,
                10.1,
                836
              ],
              "p25": [
                125.6,
                10.1,
                836
              ],
              "p75": [
                125.6,
                10.1,
                836
              ],
              "p90": [
                125.6,
                10.1,
                836
              ],
              "p95": [
                125.6,
                10.1,
                836
              ]
            }
          }
        ]
      },
      "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
            ],
            "percentiles": {
              "p5": [
                125.6,
                10.1,
                836
              ],
              "p10": [
                125.6,
                10.1,
                836
              ],
              "p25": [
                125.6,
                10.1,
                836
              ],
              "p75": [
                125.6,
                10.1,
                836
              ],
              "p90": [
                125.6,
                10.1,
                836
              ],
              "p95": [
                125.6,
                10.1,
                836
              ]
            }
          }
        ]
      }
    }
  ]
}