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.
Sample Request
API Response Explanation
Field | Description |
|---|---|
alertId | Unique identifier representing the alert |
customerId | Unique identifier representing the customer’s account |
alertTypeId | Unique identifier representing the alert type |
name | Type of alert |
cc | CC 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 |
alertName | Name of the alert |
alertToUserIdMappingForMailId | Unique identifier representing the user to email mapping |
userId | Unique identifier representing the user to whom the alert emails are sent |
ruleSetId | Unique identifier representing the rule set |
name | Name of the rule set |
ruleConditionId | Unique identifier representing the rule condition. For each rule set, there are 3 rule conditions (mileage, time interval, and engine run time) |
baseValue | Default value used for triggering the alert |
requiredValue | Value set by you for triggering the alert |
conditionType | Types of alert conditions 0 - Mileage |
reminderFired | Boolean indicating if the reminder email triggered |
alertFired | Boolean indicating if the alert triggered |
vehicleId | Unique identifier representing the vehicle for which the alert is applied |
vehicleName | Name of the vehicle |
alertId | Unique identifier representing the alert |
alertName | Name of the alert |
milesDriven | Current mileage of the vehicle |
engineRunTime | Current engine run time in Hours |
alertReminderId | Unique identifier representing the reminder alert |
days | Number of days before the actual threshold, the reminder email is to be sent |
miles | Number of miles before the actual threshold, the reminder email is to be sent |
engineHours | Number of engine hours before the actual threshold, the reminder email is to be sent |