Retrieve road safety hotspots restricted to the predefined area of the user
GET {{baseUrl}}/roadsafetyhotspots?page=<integer>&size=<integer>&longitudePoint1=<number>&latitudePoint1=<number>&longitudePoint2=<number>&latitudePoint2=<number>&typeOfObjects=<string>&eventIntensity=<integer>&relativeSize=<string>
This endpoint returns a set of road safety hotspots restricted to the predefined area of the user. The road safety hotspot data is returned in a paged response. If there are no road safety hotspots in the restricted area, an empty list is returned. 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 road safety hotspots data can also be filtered by the type of objects, the event intensity, and the relative size. 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 hotspots. 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. | |
typeOfObjects | string | Filters the road safety hotspots data by the type of objects. The filter is case-insensitive. | |
eventIntensity | string | Filters the road safety hotspots data by the event intensity. Valid values are between 1 and 5. | |
relativeSize | string | Filters the road safety hotspots data by the relative size. The filter is case-insensitive. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
x-tracking-id | string | the request tracking ID | |
Accept | string |
RESPONSES
status: OK
{"page":{"size":"\u003cinteger\u003e","number":"\u003cinteger\u003e","totalPages":"\u003cinteger\u003e","totalElements":"\u003clong\u003e"},"roadSafetyHotspots":[{"id":"\u003cuuid\u003e","longitude":"\u003cdouble\u003e","latitude":"\u003cdouble\u003e","heading":"\u003cinteger\u003e","relativeSize":"\u003cstring\u003e","eventIntensity":"\u003cinteger\u003e","roadType":"\u003cstring\u003e","typeOfObjects":"\u003cstring\u003e","nearInfrastructure":{"publicTransport":"\u003cinteger\u003e","school":"\u003cinteger\u003e","publicServices":"\u003cinteger\u003e","clinic":"\u003cinteger\u003e","shop":"\u003cinteger\u003e","restaurant":"\u003cinteger\u003e"},"distributionOverTimeToCollision":{"more2_2s":"\u003cfloat\u003e","between1_6sAnd2_2s":"\u003cfloat\u003e","between1_0sAnd1_6s":"\u003cfloat\u003e","less1_0s":"\u003cfloat\u003e"},"distributionOverWeek":{"monday":"\u003cfloat\u003e","tuesday":"\u003cfloat\u003e","wednesday":"\u003cfloat\u003e","thursday":"\u003cfloat\u003e","friday":"\u003cfloat\u003e","saturday":"\u003cfloat\u003e","sunday":"\u003cfloat\u003e"},"distributionOverDay":{"10":"\u003cfloat\u003e","11":"\u003cfloat\u003e","12":"\u003cfloat\u003e","13":"\u003cfloat\u003e","14":"\u003cfloat\u003e","15":"\u003cfloat\u003e","16":"\u003cfloat\u003e","17":"\u003cfloat\u003e","18":"\u003cfloat\u003e","19":"\u003cfloat\u003e","20":"\u003cfloat\u003e","21":"\u003cfloat\u003e","22":"\u003cfloat\u003e","23":"\u003cfloat\u003e","00":"\u003cfloat\u003e","01":"\u003cfloat\u003e","02":"\u003cfloat\u003e","03":"\u003cfloat\u003e","04":"\u003cfloat\u003e","05":"\u003cfloat\u003e","06":"\u003cfloat\u003e","07":"\u003cfloat\u003e","08":"\u003cfloat\u003e","09":"\u003cfloat\u003e"},"riskScoreOverTime":["\u003cinteger\u003e","\u003cinteger\u003e"],"numberEventsOverTime":["\u003cinteger\u003e","\u003cinteger\u003e"],"totalNumberEvents":"\u003cinteger\u003e","monthOverTime":["\u003cstring\u003e","\u003cstring\u003e"],"categoryNumberOfPassingVehicles":"\u003cstring\u003e","categoryNumberOfPassingVehiclesRange":["\u003cinteger\u003e","\u003cinteger\u003e"],"speedReduction":"\u003cstring\u003e","objectClusters":{"type":"FeatureCollection","features":[{"type":"Feature","properties":{},"geometry":{"type":"Polygon","coordinates":[[["\u003cnumber\u003e","\u003cnumber\u003e"],["\u003cnumber\u003e","\u003cnumber\u003e"],["\u003cnumber\u003e","\u003cnumber\u003e"],["\u003cnumber\u003e","\u003cnumber\u003e"]],[["\u003cnumber\u003e","\u003cnumber\u003e"],["\u003cnumber\u003e","\u003cnumber\u003e"],["\u003cnumber\u003e","\u003cnumber\u003e"],["\u003cnumber\u003e","\u003cnumber\u003e"]]]},"id":"\u003cnumber\u003e"},{"type":"Feature","properties":{},"geometry":{"type":"Polygon","coordinates":[[["\u003cnumber\u003e","\u003cnumber\u003e"],["\u003cnumber\u003e","\u003cnumber\u003e"],["\u003cnumber\u003e","\u003cnumber\u003e"],["\u003cnumber\u003e","\u003cnumber\u003e"]],[["\u003cnumber\u003e","\u003cnumber\u003e"],["\u003cnumber\u003e","\u003cnumber\u003e"],["\u003cnumber\u003e","\u003cnumber\u003e"],["\u003cnumber\u003e","\u003cnumber\u003e"]]]},"id":"\u003cnumber\u003e"}]}},{"id":"\u003cuuid\u003e","longitude":"\u003cdouble\u003e","latitude":"\u003cdouble\u003e","heading":"\u003cinteger\u003e","relativeSize":"\u003cstring\u003e","eventIntensity":"\u003cinteger\u003e","roadType":"\u003cstring\u003e","typeOfObjects":"\u003cstring\u003e","nearInfrastructure":{"publicTransport":"\u003cinteger\u003e","school":"\u003cinteger\u003e","publicServices":"\u003cinteger\u003e","clinic":"\u003cinteger\u003e","shop":"\u003cinteger\u003e","restaurant":"\u003cinteger\u003e"},"distributionOverTimeToCollision":{"more2_2s":"\u003cfloat\u003e","between1_6sAnd2_2s":"\u003cfloat\u003e","between1_0sAnd1_6s":"\u003cfloat\u003e","less1_0s":"\u003cfloat\u003e"},"distributionOverWeek":{"monday":"\u003cfloat\u003e","tuesday":"\u003cfloat\u003e","wednesday":"\u003cfloat\u003e","thursday":"\u003cfloat\u003e","friday":"\u003cfloat\u003e","saturday":"\u003cfloat\u003e","sunday":"\u003cfloat\u003e"},"distributionOverDay":{"10":"\u003cfloat\u003e","11":"\u003cfloat\u003e","12":"\u003cfloat\u003e","13":"\u003cfloat\u003e","14":"\u003cfloat\u003e","15":"\u003cfloat\u003e","16":"\u003cfloat\u003e","17":"\u003cfloat\u003e","18":"\u003cfloat\u003e","19":"\u003cfloat\u003e","20":"\u003cfloat\u003e","21":"\u003cfloat\u003e","22":"\u003cfloat\u003e","23":"\u003cfloat\u003e","00":"\u003cfloat\u003e","01":"\u003cfloat\u003e","02":"\u003cfloat\u003e","03":"\u003cfloat\u003e","04":"\u003cfloat\u003e","05":"\u003cfloat\u003e","06":"\u003cfloat\u003e","07":"\u003cfloat\u003e","08":"\u003cfloat\u003e","09":"\u003cfloat\u003e"},"riskScoreOverTime":["\u003cinteger\u003e","\u003cinteger\u003e"],"numberEventsOverTime":["\u003cinteger\u003e","\u003cinteger\u003e"],"totalNumberEvents":"\u003cinteger\u003e","monthOverTime":["\u003cstring\u003e","\u003cstring\u003e"],"categoryNumberOfPassingVehicles":"\u003cstring\u003e","categoryNumberOfPassingVehiclesRange":["\u003cinteger\u003e","\u003cinteger\u003e"],"speedReduction":"\u003cstring\u003e","objectClusters":{"type":"FeatureCollection","features":[{"type":"Feature","properties":{},"geometry":{"type":"Polygon","coordinates":[[["\u003cnumber\u003e","\u003cnumber\u003e"],["\u003cnumber\u003e","\u003cnumber\u003e"],["\u003cnumber\u003e","\u003cnumber\u003e"],["\u003cnumber\u003e","\u003cnumber\u003e"]],[["\u003cnumber\u003e","\u003cnumber\u003e"],["\u003cnumber\u003e","\u003cnumber\u003e"],["\u003cnumber\u003e","\u003cnumber\u003e"],["\u003cnumber\u003e","\u003cnumber\u003e"]]]},"id":"\u003cnumber\u003e"},{"type":"Feature","properties":{},"geometry":{"type":"Polygon","coordinates":[[["\u003cnumber\u003e","\u003cnumber\u003e"],["\u003cnumber\u003e","\u003cnumber\u003e"],["\u003cnumber\u003e","\u003cnumber\u003e"],["\u003cnumber\u003e","\u003cnumber\u003e"]],[["\u003cnumber\u003e","\u003cnumber\u003e"],["\u003cnumber\u003e","\u003cnumber\u003e"],["\u003cnumber\u003e","\u003cnumber\u003e"],["\u003cnumber\u003e","\u003cnumber\u003e"]]]},"id":"\u003cnumber\u003e"}]}}]}