These docs are for v1. Click to read the latest docs for v3.

View

Use this API to get the details of a specific maintenance alert. You need to pass the name of the alert while calling this API.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Sample Request

https://api.azuga.com/azuga-ws/v1/maintenance/view.json

API Response Explanation

FieldDescription
alertIdUnique identifier representing the alert
customerIdUnique identifier representing the customer’s account
alertTypeIdUnique identifier representing the alert type
nameType of alert
ccCC addresses to which the alert emails are sent
mode

Mode of sending the alert emails. There are two modes:

1 - Instant, the email will be sent as soon as the vehicle crosses the alert threshold set
2 - Hourly, a summary of alert emails will be sent once per hour

alertNameName of the alert
alertToUserIdMappingForMailIdUnique identifier representing the user to email mapping
userIdUnique identifier representing the user to whom the alert emails are sent
ruleSetIdUnique identifier representing the rule set
nameName of the rule set
ruleConditionIdUnique identifier representing the rule condition. For each rule set, there are 3 rule conditions (mileage, time interval, and engine run time)
baseValueDefault value used for triggering the alert
requiredValueValue set by you for triggering the alert
conditionType

Types of alert conditions

0 - Mileage
1 - Time Interval
2 - Engine Run Time

reminderFiredBoolean indicating if the reminder email triggered
alertFiredBoolean indicating if the alert triggered
vehicleIdUnique identifier representing the vehicle for which the alert is applied
vehicleNameName of the vehicle
alertIdUnique identifier representing the alert
alertNameName of the alert
milesDrivenCurrent mileage of the vehicle
engineRunTimeCurrent engine run time in Hours
alertReminderIdUnique identifier representing the reminder alert
daysNumber of days before the actual threshold, the reminder email is to be sent
milesNumber of miles before the actual threshold, the reminder email is to be sent
engineHoursNumber of engine hours before the actual threshold, the reminder email is to be sent
Query Params
string
required

Name of the alert

Responses

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