API responses - Xweather Protect, Xweather Optimize, Xweather Observe

Vaisala Xweather Protect, Xweather Optimize, and Xweather Observe Measurement History by Location API Reference

Product status
Document code
M213056EN-C
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

Example

The example shows a single parameter in the response. In real responses, all parameters from a sensor are returned.

[
  {
    "observedTime": "2023-05-12T14:49:00Z",
    "value": 969.1,
    "sourceId": "urn:dev:ops:16961-WXT530-S1234567",
    "quality": {
      "qualityValue": 8500,
      "checkLevel": 2,
      "checkedAt": "2023-05-12T14:49:00Z",
      "qualityReasons": [
        {
          "description": "Value 969.1 is within the range DoubleRange(low=500.0, high=1100.0) thus ACCEPTED"
        }
      ]
    },
    "measurementType": {
      "parameter": "AIR_PRESSURE",
      "unit": "HECTOPASCALS",
      "statistics": "MEAN",
      "period": "PT1M",
      "height": 2,
      "dataLevel": "LEVEL_TWO"
    }
  }
]