Road Surface Route
The Road Surface API retrieves a list of road surface conditions at each point of a route path. (North America only)
POST /roadSurface/route
Request Element
The request consists of a JSON object that gets POSTed in the body.
| Element | Definition | Required |
|---|---|---|
routePath
| An array of double array consisting of the route path where each inner element is the longitude an latitude, ex [[-76.0,41.0],[75.0,41.7]] | Y |
routeDuration
| The duration of the route in minutes (non-negative integer). This value if non-zero is used to calculate the temporal offset for each point in the route path and will report current conditions for all points in the route when not supplied (no temporal offset). If the route is longer than 1380 minutes, road surface data will be reported as not in range (99) for any point beyond this cutoff. | N |
Sample JSON Post Body
{
"routePath": [
[-83.000363, 39.960776],
[-83.000547, 39.961744],
[-83.000642, 39.962226],
[-82.999444, 39.962349],
[-82.997927, 39.962236],
[-82.997843, 39.961815],
[-82.997582, 39.96048],
[-82.997575, 39.960446],
[-82.997447, 39.959789],
[-82.997321, 39.959116]
],
"routeDuration": 315
}
Sample Response
The conditions are returned in an integer array where:
- Dry road=1
- Wet road=2
- Ice/snow=3
- Mix water/snow=4
- Dew=5
- Melting snow=6
- Frost=7
- Icing rain=8
- Not in range=99
[1, 1, 1, 1, 1, 3, 3, 5, 1, 1, 5];