Retrieve traffic signs restricted to the predefined area of the user
GET {{baseUrl}}/trafficsigns?page=<integer>&size=<integer>&longitudePoint1=<number>&latitudePoint1=<number>&longitudePoint2=<number>&latitudePoint2=<number>&lonelySign=<boolean>&minConfidence=<float>&permanency=<string>&type=<string>
This endpoint returns a set of traffic signs restricted to the predefined area of the user. The traffic signs data is returned in a paged response. If there are no traffic signs in the defined area, an empty list is returned. Note that missing fields in individual traffic sign 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 traffic signs data can also be filtered by the lonely sign, the confidence, the permanency, and the type of the traffic sign. 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. 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. | |
lonelySign | string | Boolean value to filter lonely signs. It is intended to be used to exclude traffic signs from the returned data that are considered lonely: The parameter is set to false to only return non-lonely traffic signs. By default, all signs are returned, regardless of whether they are lonely or not. | |
minConfidence | string | Filters the traffic signs data by the confidence value. Can be between 0 and 1. Only traffic signs data with a confidence value greater than or equal to the provided value are returned. | |
permanency | string | Filters the traffic signs data by the permanency value. The filter is case-insensitive. Only traffic signs data with the provided permanency value are returned. | |
type | string | Filters the traffic signs data by the type value. The filter is case-insensitive. Only traffic signs data with the provided type value are returned. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
x-tracking-id | string | the request tracking ID | |
Accept | string |
RESPONSES
status: OK
{"trafficSigns":[{"id":"\u003cuuid\u003e","latitude":"\u003cfloat\u003e","longitude":"\u003cfloat\u003e","heading":"\u003cinteger\u003e","confidence":"\u003cfloat\u003e","permanency":"DYNAMIC","signValue":"110","timestamp":"\u003clong\u003e","type":"MOTORWAY_START","lonelySign":"\u003cboolean\u003e"},{"id":"\u003cuuid\u003e","latitude":"\u003cfloat\u003e","longitude":"\u003cfloat\u003e","heading":"\u003cinteger\u003e","confidence":"\u003cfloat\u003e","permanency":"VARIABLE","signValue":"110","timestamp":"\u003clong\u003e","type":"NO_OVERTAKING_TRUCKS_END","lonelySign":"\u003cboolean\u003e"}],"page":{"size":"\u003cinteger\u003e","number":"\u003cinteger\u003e","totalPages":"\u003cinteger\u003e","totalElements":"\u003clong\u003e"}}