Merge pull request #634 from hargata/Hargata/api.enhancement.dos

Added documentation and new API endpoint to calculate adjusted odometer.

Controllers/APIController.cs

@@ -178,6 +178,21 @@ namespace CarCareTracker.Controllers
         }
         [TypeFilter(typeof(CollaboratorFilter))]
         [HttpGet]
+        [Route("/api/vehicle/adjustedodometer")]
+        public IActionResult AdjustedOdometer(int vehicleId, int odometer)
+        {
+            var vehicle = _dataAccess.GetVehicleById(vehicleId);
+            if (vehicle == null || !vehicle.HasOdometerAdjustment)
+            {
+                return Json(odometer);
+            } else
+            {
+                var convertedOdometer = (odometer + int.Parse(vehicle.OdometerDifference)) * int.Parse(vehicle.OdometerMultiplier);
+                return Json(convertedOdometer);
+            }
+        }
+        [TypeFilter(typeof(CollaboratorFilter))]
+        [HttpGet]
         [Route("/api/vehicle/servicerecords")]
         public IActionResult ServiceRecords(int vehicleId)
         {

Views/API/Index.cshtml

@@ -40,6 +40,36 @@
         No Params
     </div>
 </div>
+<div class="row">
+    <div class="col-1">
+        GET
+    </div>
+    <div class="col-5 copyable">
+        <code>/api/vehicle/info</code>
+    </div>
+    <div class="col-3">
+        Returns details for list of vehicles or specific vehicle
+    </div>
+    <div class="col-3">
+        VehicleId - Id of Vehicle(optional)
+    </div>
+</div>
+<div class="row">
+    <div class="col-1">
+        GET
+    </div>
+    <div class="col-5 copyable">
+        <code>/api/vehicle/adjustedodometer</code>
+    </div>
+    <div class="col-3">
+        Returns odometer reading with adjustments applied
+    </div>
+    <div class="col-3">
+        vehicleId - Id of Vehicle
+        <br />
+        odometer - Unadjusted odometer
+    </div>
+</div>
 <div class="row">
     <div class="col-1">
         GET