The ZoneAlert method allows you to access information specific to your Zone Alerts (Alerts of type Geofence or Radius) associated with your account.
This method only supports GET and is primarily used to retrieve AlertIDs (aka ZoneIDs) to use in the TimeInZoneReport API call.
The following datatype will be JSONified and returned for methods which retrieve ZoneAlert values. Method requests which create new Alerts or update existing Alerts will be parsed for a JSON representation of this data structure.
| public | UInt64 | AlertId; | // A unique identifier for the Alert. Use this when making further API calls specific to this Alert. For ZoneAlerts, this is also known as ZoneID |
| public | String | AlertName; | // The name of this Alert. |
| public | String | AlertTypeName; | // The Type of this ZoneAlert. Radius or Geofence. |
| public | Int32[] | VehicleId; | // The vehicle(s) this Alert tracks. |
| public | Double[][] | Points; | // (Geofence ZoneAlert only) This is a list of lat/long points that defines a polygonal geofence zone. Will be NULL for Radius Zones. |
| public | Double? | Radius; | // (Radius ZoneAlert only) This is the distance from the center of a circular geofence or a route path which will trigger the alert. Will be NULL for Geofence Zones. |
| public | Double? | Latitude; | // (Radius ZoneAlert only) The Latitude value of the center point. Will be NULL for Geofence Zones. |
| public | Double? | Longitude; | // (Radius ZoneAlert only) The Longitude value of the center point. Will be NULL for Geofence Zones. |
| public | String | ZoneColor; | // The color value of the Zone (as shown in Web Application) |
The following list provides a reference for all valid /ZoneAlert HTTP requests.
Summary: Return USFT's information about all ZoneAlerts (Geofence/Radius alerts) viewable by your Account.
Returns: A list of all ZoneAlerts viewable by your Account
Parameters:
- account: (Optional) If this parameter is included, the method will be run on behalf of the specified child Account (if valid) (FromUri)