Create

post

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

Use this API to create a maintenance alert that will notify you when your next vehicle service is due. While creating the API, you can set the conditions for triggering the alert.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
Sample Request
https://api.azuga.com/azuga-ws/v1/maintenance/add.json

{  
   "alertName":"Maintenance Alert - W12",
   "vehicleName":"1674617864",
   "user":[  
      "cad77fc0-2588-11e7-ac81-670c6342b1b5"
   ],
   "notification":"false",
   "serviceType":[  
      {  
         "id":"10",
         "mileage":"20",
         "hours":"2",
         "months":"1",
         "lsd":"07-23-2017 12:00AM"
      },
      {  
         "id":"15",
         "mileage":"",
         "hours":"3",
         "months":"",
         "lsd":"07-24-2017 12:00AM"
      },
      {  
         "id":"21",
         "mileage":"15",
         "hours":"",
         "months":"",
         "lsd":"07-24-2017 12:00AM"
      },
      {  
         "id":"23",
         "mileage":"15",
         "hours":"2",
         "months":"6",
         "lsd":"07-24-2017 12:00AM"
      }
   ],
   "alertReminder":{  
      "miles":"10",
      "engineHours":"1",
      "days":"7"
   }
}

API Response Explanation

Field	Description
code	API status code
message	API Message (Success/Failure)
generatedAt	API generation timestamp in UTC

Body Params

alertName

string

required

Name of the alert

vehicleName

string

required

Name of the vehicle

user

array of strings

required

Array of unique identifiers representing the users to which the alert is to be sent

user*

notification

boolean

Defaults to false

Boolean indicating if the alert notification is turned ON or OFF.

serviceType

array

Types of services

serviceType

int32

required

Unique identifier representing the service type. The following values are valid: 1 - Air Filter Replacement, 2 - Brake Inspection, 3 - Battery Inspection, 4 - Engine/Drive Belt Replacement, 5 - Engine Coolant Replacement, 6 - Engine Oil Replacement, 7 - Fuel Filter Replacement, 8 - General Service, 9 - Lubricate Chassis, 10 - Radiator Flush, 11 - Rear Axle Fluid Replacement, 12 - Spark Plug Replacement, 13 - Tire Rotation, 14 - Tire Replacement, 15 - Transmission Fluid Replacement, 16 - Wheel Alignment, 17 - Safety Inspection, 18 - DOT Inspection, 19 - Miscellaneous - Parts, 20 - Crane Inspection, 21 - Dielectric Testing Inspection, 22 - IFTA Updates, 23 - Public Service Commission inspection, 24 - External Annual Vehicle inspection

mileage

int32

Alert threshold based on the miles driven by the vehicle. At least 1 of the following fields is mandatory: mileage, hours, months

hours

int32

Alert threshold based on the vehicle’s engine run time (in Hours). At least 1 of the following fields is mandatory: mileage, hours, months

months

int32

Alert threshold based on the time interval (in Months) of vehicle service. At least 1 of the following fields is mandatory: mileage, hours, months

lsd

date-time

required

Last service date in MM-DD-YYYY HH:MMAM/PM format

miles

int32

Number of miles before the actual threshold, the reminder email is to be sent

engineHours

int32

Number of engine hours before the actual threshold, the reminder email is to be sent

days

int32

Number of days before the actual threshold, the reminder email is to be sent

Responses

Sample Request

API Response Explanation

200200

400400