Weather alerts for a single car location resource

This resource provides information about weather alerts for a single location (car position) and width (circular area).

You can find more details on the applicable query and path parameters in the sections below. The base_url will be provided during the process of obtaining credentials.

Authorization

Each request is authenticated and requires a valid bearer token to be included in HTTP Authorization header:

Authorization: Bearer <token>

For more information about obtaining credentials, see the Identity and Access Management Developer Guide.

Request payload

Request is in geo-json format and accept Point geometry. Circle radius can be defined throug width value in feature properties. Value in integer in range 1000 - 10000 m. Default is 50000m.

Response

On success, the response status is 200 OK and the response payload contains the weather alerts that affect the specified car position area.

The response is in GeoJSON format (specified in RFC 7946). Each GeoJSON feature in the response describes one or multiple weather alerts. The feature geometry is defined as a polygon or a multi-polygon and describes the affected area.

Weather alerts update frequency

Minimal time between updates is 10 minutes. In practice, the update frequency depends on how national weather institutes update the data.

Example

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          151.2011021,
          -33.8831135
        ]
      },
      "properties": {
        "width": 30000
      }
    }
  ]
}

Response is the similar as for weather alerts along the route.

On failure, the response has a different status code and may include additional information about the error. You can use this additional information to troubleshoot this issue. For more information see Response Status Codes