Retrieve micro weather events restricted to the predefined area of the user
GET {{baseUrl}}/microweather?page=<integer>&size=<integer>&longitudePoint1=<number>&latitudePoint1=<number>&longitudePoint2=<number>&latitudePoint2=<number>&rainIntensity=<string>&minConfidence=<float>&roadCondition=<string>&minTemperature=<float>&maxTemperature=<float>
This endpoint returns micro weather data limited to the predefined area of the user. The micro weather data is returned in a paged response. If there is no micro weather data in the defined area, an empty list is returned. Note that missing fields in individual micro weather are returned as null
values. To additionally limit the returned data, a bounding box can be defined as geolocation filter. The bounding box is defined by two points, each represented by a longitude and a latitude coordinate. The first point is defined by the longitudePoint1 and latitudePoint1 query parameters. The second point is defined by the longitudePoint2 and latitudePoint2 query parameters. All four query parameters are optional, but if one of them is provided, all four must be provided to define a bounding box as geolocation filter.
Besides the bounding box, the micro weather data can also be filtered by the rain intensity, the confidence value, the road condition, and the temperature. If more than one filter is provided, the filters are combined with a logical AND.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
page | string | The page number used for the pagination | |
size | string | The size of the response page used for the pagination. The size is given in number of events. If the requested page size exceeds the maximum allowed page size, a validation error is returned. | |
longitudePoint1 | string | The longitude coordinate (x-axis) of the first point defining a bounding box as geolocation filter. Valid values are between -180 and 180. | |
latitudePoint1 | string | The latitude coordinate (y-axis) of the first point defining a bounding box as geolocation filter. Valid values are between -90 and 90. | |
longitudePoint2 | string | The longitude coordinate (x-axis) of the second point defining a bounding box as geolocation filter. Valid values are between -180 and 180. | |
latitudePoint2 | string | The latitude coordinate (y-axis) of the second point defining a bounding box as geolocation filter. Valid values are between -90 and 90. | |
rainIntensity | string | Filters the micro weather data by the rain intensity. The filter is case-insensitive and can be one of the following values: NONE, LOW, MEDIUM, HIGH, UNRECOGNIZED | |
minConfidence | string | Filters the micro weather data by the confidence value. Can be between 0 and 1. Only micro weather data with a confidence value greater than or equal to the provided value are returned. | |
roadCondition | string | Filters the micro weather data by the road condition. The filter is case-insensitive and can be one of the following values: SLIPPERY_ICE, SLIPPERY_WET, DRY, UNRECOGNIZED, WET | |
minTemperature | string | Filters the micro weather data by the temperature value. Only micro weather data with a temperature value greater than or equal to the provided value are returned. | |
maxTemperature | string | Filters the micro weather data by the temperature value. Only micro weather data with a temperature value less than or equal to the provided value are returned. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
x-tracking-id | string | the request tracking ID | |
Accept | string |
RESPONSES
status: OK
{"microWeather":[{"latitude":"\u003cfloat\u003e","longitude":"\u003cfloat\u003e","confidence":"\u003cfloat\u003e","temperature":"\u003cfloat\u003e","rainIntensity":"\u003cstring\u003e","roadCondition":"\u003cstring\u003e","timestamp":"\u003clong\u003e"},{"latitude":"\u003cfloat\u003e","longitude":"\u003cfloat\u003e","confidence":"\u003cfloat\u003e","temperature":"\u003cfloat\u003e","rainIntensity":"\u003cstring\u003e","roadCondition":"\u003cstring\u003e","timestamp":"\u003clong\u003e"}],"page":{"size":"\u003cinteger\u003e","number":"\u003cinteger\u003e","totalElements":"\u003clong\u003e","totalPages":"\u003cinteger\u003e"}}