Retrieve micro weather data
POST {{baseUrl}}/microweather?page=<integer>&size=<integer>
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 GeoJSON polygon or multi-polygon can be defined as geolocation filter. The GeoJSON filter geometry is defined in the request body. The provided geometry is validated, e.g., it must be a valid GeoJSON polygon or multi-polygon with valid coordinate values. Also, requests containing too complex geometries are rejected for performance reasons.
Besides the GeoJSON filter, 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. |
Request Body
{"geoJson"=>{"type"=>"Polygon", "coordinates"=>[[["<number>", "<number>"], ["<number>", "<number>"], ["<number>", "<number>"], ["<number>", "<number>"]], [["<number>", "<number>"], ["<number>", "<number>"], ["<number>", "<number>"], ["<number>", "<number>"]]], "bbox"=>["<number>", "<number>", "<number>", "<number>"]}, "rainIntensity"=>"<string>", "minConfidence"=>"<float>", "roadCondition"=>"<string>", "minTemperature"=>"<float>", "maxTemperature"=>"<float>"}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
x-tracking-id | string | the request tracking ID | |
Content-Type | string | ||
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"}}