API Reference
SupportAPI Feedback

Edit an Alert

put
https://services.azuga.com/azuga-ws-oauth/v3/alerts/.json

This API allows you to edit an alert. You are allowed to edit alerts for those you have access to. Only one alert can be edited per API call. You need to pass the unique identifier of the alert in the Edit Alert API definition.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of the alert you wish to update

Body Params
string
required

Unique identifier of the alert to be edited

string
required

Name of the alert that needs to be configured.

int32
required

Unique identifier representing the type of alert needs to be created. The alertTypeId and the corresponding alert type name is described below: 1, Speeding 2, Stop Time 3, Idling 4, Device Plugged In/Unplugged 6, Unauthorized Usage 7, Braking 8, Sudden Acceleration 9, Check Engine Light 10, Not Tracking 13, Low Fuel 14, Ignition 15, Posted Speed Limit 16, Low Battery 17, Cornering 18, Panic Alert 19, Seat belt 20, Unknown Driver 21, Unauthorized Occupant Count 22, Beacon Unused 39, Fuel Location Exception 40, Fuel Quantity Exception 41, SafetyCam Connected/Disconnected 42, VIN Change 43, SafetyCam Button Pressed 44, SafetyCam Connectivity Status 46, Back up detection

int32

The time in hours to send the alert summary. 0 = Trigger the alert instantly 1 = Trigger the alert every 1 hour

json

Pass the below objects based on the type of alert. PRIORITY: Type of notification in web/mobile. POPUP_EVERYUSER: Popup with every user acknowledgement POPUP: Popup with any user acknowledgement BANNER: Banner type notification IDLETIME: Use this field for Idling alerts to configure the threshold for Idling time HB: HB=1 if the braking alert(alertTypeId=7) needs to be configured with Hard Braking HCB: HCB=1 if the braking alert(alertTypeId=7) needs to be configured with Hard Core Braking. Check Engine Light Alert(alertType : 9) = Null /// Device Plugged In/Unplugged Alert(alertType : 4) = Null /// Low Battery Alert (alertType : 16) = Null /// Standard Panic Alert(alertType : 18) = Null /// SafetyCam Button Pressed Alert (alertType : 43) = Null /// Sudden Acceleration Alert(alertType : 8) = Null /// Unauthorized Usage Alert(alertType : 6) = Null /// VIN Change Alert(alertType : 42) = Null /// Fuel Location Exception Alert(alertType : 39): DISTANCELIMIT - Trigger value if distance difference exceeds this value /// Fuel Quantity Exception Alert(alertType : 40): FUELDIFFERENCE - Transactions flagged when the difference is greater than this value in litres. /// Beacon Unused Alert(alertType : 22) NO_OF_DAYS - To trigger alert when the beacon unused beyond this value. /// Idling Alert(alertType : 3) IDLETIME - Trigger when the idle time exceeds the value in minutes /// Ignition Alert(alertType : 14) IGNITION_STATE - The valid values are “IgnitionOn_IgnitionOff_FirstOn” / “IgnitionOn_IgnitionOff” / “IgnitionOff” / “IgnitionOn” etc /// Standard Low Fuel Alert(alertType : 13) - LOWFUEL_THRESHOLD - To trigger alert when the fuel capacity ranges to this value in percentage LOWFUEL_RADIUS - Radius value in miles LOWFUEL_CATEGORY - 1 = Nearest; 2 - Cheapest LOWFUEL_NUM_OF_GAS_STATIONS - “1”, - Valid values are - 1,2,3 LOW_FUEL_FUEL_TYPE - Valid values are Midgrade, Premium, Unleaded LOWFUEL_FREQUENCY - 2- Instant, 0 - Once per trip ///
 Standard Not Tracking Alert(alertType : 10) - NOT_TRACKING_TIME - Wait time /// Posted Speed Limit Alert(alertType - 15) POSTED_SPEED_DURATION: 0 - Add 0 if Duration is instant. Add value in seconds for any duration;
POSTED_SPEED_EXCEEDS_BY: 0 - Add 0 if the alert needs to be triggered at Posted speed for others add different value;
POSTED_SPEED_EXCEEDS_BY_UNIT: The valid value is “SPEED" /// Seat Belt Alert(alertType - 19) - SEATBELT - Value in percentage /// Speeding Alert(alertType - 1) SPEEDLIMIT - Speedlimit in MPH /// Stop Alert(alertType - 2) STOPTIME : Stoptime in minutes /// Unauthorized Occupant Count Alert(alertType - 21) ALERT_WHILE_IDLING - 1 = Enabled, 0 = Disabled NO_OF_OCCUPANTS - Count of number of occupants allowed /// Unknown Driver Alert(alertType - 20) REMINDER_FREQ = -1 for Once per trip; Others - value for reminder frequency REMINDER_FREQ_UNITS - “ONCE_PER_TRIP” for Once per trip reminder frequency WAIT_AFTER_IGNITION_VAL - Wait after ignition ON value WAIT_AFTER_IGNITION_VAL_UNITS - Minutes/Hours ///

string

The comma separated unique identifiers of the vehicles that need to be associated with the alert.

string

The comma separated unique identifiers of the users that needs to receive the alert notification.

string

The comma separated email Ids to be configured in CC

boolean

Boolean value representing the alert needs to be notified over email

boolean

Boolean value representing the alert needs to be notified over web

boolean

Boolean value representing the alert needs to be notified in AFM(mobile app)

boolean

Boolean value representing the alert notification sound

boolean

Boolean to indicate whether the alert needs to be muted

string

The roleId separated by commas representing to notify the Group Admins with Role

boolean

Boolean to indicate whether the group admin needs to be notified

boolean

Boolean to indicate whether the associated driver of the vehicle needs to be notified

boolean

Boolean value which represents whether the configuration is group/vehicle based groupAlert=true implies that the alert is a group based alert.

string

Frequency of the alert email. 1 - Indicates that the alert is triggered instantly 2 - Indicates that the alert is triggered as a summary alert.

string

Intensity of the buzzer 53 - High 37 - Medium 21 - Low 5 - Off

string

The comma separated unique identifiers of group names that need to be associated with the alert. Vehicles under these groups would be considered for the alert.

int32

Time for summary in seconds. For example 5.30 AM the corresponding seconds value is 330

Responses

Updated about 1 year ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago