Retrieve waviness data restricted to the predefined area of the user
GET {{baseUrl}}/waviness?page=<integer>&size=<integer>&longitudePoint1=<number>&latitudePoint1=<number>&longitudePoint2=<number>&latitudePoint2=<number>&minIri=<float>&minIriConfidence=<float>
This endpoint returns a set of waviness data restricted to the predefined area of the user. The waviness data is returned in a paged response. If there is no waviness data in the defined area, an empty list is returned. Note that missing fields in individual waviness data 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 waviness data can also be filtered by the iri and the iriConfidence values. If more than one filter is provided, all 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. | |
minIri | string | Filters the waviness data by the iriFwd or iriRev value. Only waviness data with an iriFwd or iriRev value greater than or equal to the provided value is returned. | |
minIriConfidence | string | Filters the waviness data by the iriConfidenceFwd or iriConfidenceRev value. Only waviness data with an iriConfidenceFwd or iriConfidenceRev value greater than or equal to the provided value is returned. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
x-tracking-id | string | the request tracking ID | |
Accept | string |
RESPONSES
status: OK
{"waviness":[{"iriFwd":"\u003cfloat\u003e","iriRev":"\u003cfloat\u003e","iriConfidenceFwd":"\u003cfloat\u003e","iriConfidenceRev":"\u003cfloat\u003e","geometry":"\u003cstring\u003e","timestamp":"\u003clong\u003e"},{"iriFwd":"\u003cfloat\u003e","iriRev":"\u003cfloat\u003e","iriConfidenceFwd":"\u003cfloat\u003e","iriConfidenceRev":"\u003cfloat\u003e","geometry":"\u003cstring\u003e","timestamp":"\u003clong\u003e"}],"page":{"size":"\u003cinteger\u003e","number":"\u003cinteger\u003e","totalPages":"\u003cinteger\u003e","totalElements":"\u003clong\u003e"}}