lubelog/Views/API/Index.cshtml

@{
    ViewData["Title"] = "API";
}
<div class="row">
    <div class="d-flex justify-content-center">
        <h6 class="display-6 mt-2">API</h6>
    </div>
</div>
<div class="row">
    <div class="d-flex justify-content-center">
        <p class="lead">If authentication is enabled, use the credentials of the user for Basic Auth(RFC2617)</p>
    </div>
</div>
<hr />
<div class="row">
    <div class="col-1">
        <h6>Method</h6>
    </div>
    <div class="col-5 copyable">
        <h6>Endpoint</h6>
    </div>
    <div class="col-3">
        <h6>Description</h6>
    </div>
    <div class="col-3">
        <h6>Parameters</h6>
    </div>
</div>
<div class="row api-method">
    <div class="col-1">
        <span class="badge bg-success">GET</span>
    </div>
    <div class="col-5 copyable testable">
        <code>/api/vehicles</code>
    </div>
    <div class="col-3">
        Returns a list of vehicles
    </div>
    <div class="col-3">
        No Params
    </div>
</div>
<div class="row api-method">
    <div class="col-1">
        <span class="badge bg-success">GET</span>
    </div>
    <div class="col-5 copyable testable">
        <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 api-method">
    <div class="col-1">
        <span class="badge bg-success">GET</span>
    </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 api-method">
    <div class="col-1">
        <span class="badge bg-success">GET</span>
    </div>
    <div class="col-5 copyable">
        <code>/api/vehicle/odometerrecords</code>
    </div>
    <div class="col-3">
        Returns a list of odometer records for the vehicle
    </div>
    <div class="col-3">
        vehicleId - Id of Vehicle
    </div>
</div>
<div class="row api-method">
    <div class="col-1">
        <span class="badge bg-success">GET</span>
    </div>
    <div class="col-5 copyable">
        <code>/api/vehicle/odometerrecords/latest</code>
    </div>
    <div class="col-3">
        Returns last reported odometer for the vehicle
    </div>
    <div class="col-3">
        vehicleId - Id of Vehicle
    </div>
</div>
<div class="row api-method">
    <div class="col-1">
        <span class="badge bg-primary">POST</span>
    </div>
    <div class="col-5 copyable">
        <code>/api/vehicle/odometerrecords/add</code>
    </div>
    <div class="col-3">
        Adds Odometer Record to the vehicle
    </div>
    <div class="col-3">
        vehicleId - Id of Vehicle
        <br />
        Body(form-data): {<br />
        date - Date to be entered<br />
        initialOdometer - Initial Odometer reading(optional)<br />
        odometer - Odometer reading<br />
        notes - notes(optional)<br />
        tags - tags separated by space(optional)<br />
        extrafields - <a class="link-body-emphasis link-offset-2 link-underline-opacity-25 link-underline-opacity-100-hover reminder-calendar-item" onclick="showExtraFieldsInfo()">extrafields(optional)</a><br />
        files - <a class="link-body-emphasis link-offset-2 link-underline-opacity-25 link-underline-opacity-100-hover reminder-calendar-item" onclick="showAttachmentsInfo()">attachments(optional)</a><br />
        }
    </div>
</div>
<div class="row api-method">
    <div class="col-1">
        <span class="badge text-bg-warning">PUT</span>
    </div>
    <div class="col-5 copyable">
        <code>/api/vehicle/odometerrecords/update</code>
    </div>
    <div class="col-3">
        Updates Odometer Record
    </div>
    <div class="col-3">
        Body(form-data): {<br />
        Id - Id of Odometer Record<br />
        date - Date to be entered<br />
        initialOdometer - Initial Odometer reading<br />
        odometer - Odometer reading<br />
        notes - notes(optional)<br />
        tags - tags separated by space(optional)<br />
        extrafields - <a class="link-body-emphasis link-offset-2 link-underline-opacity-25 link-underline-opacity-100-hover reminder-calendar-item" onclick="showExtraFieldsInfo()">extrafields(optional)</a><br />
        files - <a class="link-body-emphasis link-offset-2 link-underline-opacity-25 link-underline-opacity-100-hover reminder-calendar-item" onclick="showAttachmentsInfo()">attachments(optional)</a><br />
        }
    </div>
</div>
<div class="row api-method">
    <div class="col-1">
        <span class="badge text-bg-danger">DELETE</span>
    </div>
    <div class="col-5 copyable">
        <code>/api/vehicle/odometerrecords/delete</code>
    </div>
    <div class="col-3">
        Deletes Odometer Record
    </div>
    <div class="col-3">
        Id - Id of Odometer Record
    </div>
</div>
<div class="row api-method">
    <div class="col-1">
        <span class="badge bg-success">GET</span>
    </div>
    <div class="col-5 copyable">
        <code>/api/vehicle/servicerecords</code>
    </div>
    <div class="col-3">
        Returns a list of service records for the vehicle
    </div>
    <div class="col-3">
        vehicleId - Id of Vehicle
    </div>
</div>
<div class="row api-method">
    <div class="col-1">
        <span class="badge bg-primary">POST</span>
    </div>
    <div class="col-5 copyable">
        <code>/api/vehicle/servicerecords/add</code>
    </div>
    <div class="col-3">
        Adds Service Record to the vehicle
    </div>
    <div class="col-3">
        vehicleId - Id of Vehicle
        <br />
        Body(form-data): {<br />
        date - Date to be entered<br />
        odometer - Odometer reading<br />
        description - Description<br/>
        cost - Cost<br />
        notes - notes(optional)<br />
        tags - tags separated by space(optional)<br />
        extrafields - <a class="link-body-emphasis link-offset-2 link-underline-opacity-25 link-underline-opacity-100-hover reminder-calendar-item" onclick="showExtraFieldsInfo()">extrafields(optional)</a><br />
        files - <a class="link-body-emphasis link-offset-2 link-underline-opacity-25 link-underline-opacity-100-hover reminder-calendar-item" onclick="showAttachmentsInfo()">attachments(optional)</a><br />
        }
    </div>
</div>
<div class="row api-method">
    <div class="col-1">
        <span class="badge text-bg-warning">PUT</span>
    </div>
    <div class="col-5 copyable">
        <code>/api/vehicle/servicerecords/update</code>
    </div>
    <div class="col-3">
        Updates Service Record
    </div>
    <div class="col-3">
        Body(form-data): {<br />
        Id - Id of Service Record<br />
        date - Date to be entered<br />
        odometer - Odometer reading<br />
        description - Description<br />
        cost - Cost<br />
        notes - notes(optional)<br />
        tags - tags separated by space(optional)<br />
        extrafields - <a class="link-body-emphasis link-offset-2 link-underline-opacity-25 link-underline-opacity-100-hover reminder-calendar-item" onclick="showExtraFieldsInfo()">extrafields(optional)</a><br />
        files - <a class="link-body-emphasis link-offset-2 link-underline-opacity-25 link-underline-opacity-100-hover reminder-calendar-item" onclick="showAttachmentsInfo()">attachments(optional)</a><br />
        }
    </div>
</div>
<div class="row api-method">
    <div class="col-1">
        <span class="badge text-bg-danger">DELETE</span>
    </div>
    <div class="col-5 copyable">
        <code>/api/vehicle/servicerecords/delete</code>
    </div>
    <div class="col-3">
        Deletes Service Record
    </div>
    <div class="col-3">
        Id - Id of Service Record
    </div>
</div>
<div class="row api-method">
    <div class="col-1">
        <span class="badge bg-success">GET</span>
    </div>
    <div class="col-5 copyable">
        <code>/api/vehicle/repairrecords</code>
    </div>
    <div class="col-3">
        Returns a list of repair records for the vehicle
    </div>
    <div class="col-3">
        vehicleId - Id of Vehicle
    </div>
</div>
<div class="row api-method">
    <div class="col-1">
        <span class="badge bg-primary">POST</span>
    </div>
    <div class="col-5 copyable">
        <code>/api/vehicle/repairrecords/add</code>
    </div>
    <div class="col-3">
        Adds Repair Record to the vehicle
    </div>
    <div class="col-3">
        vehicleId - Id of Vehicle
        <br />
        Body(form-data): {<br />
        date - Date to be entered<br />
        odometer - Odometer reading<br />
        description - Description<br />
        cost - Cost<br />
        notes - notes(optional)<br />
        tags - tags separated by space(optional)<br />
        extrafields - <a class="link-body-emphasis link-offset-2 link-underline-opacity-25 link-underline-opacity-100-hover reminder-calendar-item" onclick="showExtraFieldsInfo()">extrafields(optional)</a><br />
        files - <a class="link-body-emphasis link-offset-2 link-underline-opacity-25 link-underline-opacity-100-hover reminder-calendar-item" onclick="showAttachmentsInfo()">attachments(optional)</a><br />
        }
    </div>
</div>
<div class="row api-method">
    <div class="col-1">
        <span class="badge text-bg-warning">PUT</span>
    </div>
    <div class="col-5 copyable">
        <code>/api/vehicle/repairrecords/update</code>
    </div>
    <div class="col-3">
        Updates Repair Record
    </div>
    <div class="col-3">
        Body(form-data): {<br />
        Id - Id of Repair Record <br />
        date - Date to be entered<br />
        odometer - Odometer reading<br />
        description - Description<br />
        cost - Cost<br />
        notes - notes(optional)<br />
        tags - tags separated by space(optional)<br />
        extrafields - <a class="link-body-emphasis link-offset-2 link-underline-opacity-25 link-underline-opacity-100-hover reminder-calendar-item" onclick="showExtraFieldsInfo()">extrafields(optional)</a><br />
        files - <a class="link-body-emphasis link-offset-2 link-underline-opacity-25 link-underline-opacity-100-hover reminder-calendar-item" onclick="showAttachmentsInfo()">attachments(optional)</a><br />
        }
    </div>
</div>
<div class="row api-method">
    <div class="col-1">
        <span class="badge text-bg-danger">DELETE</span>
    </div>
    <div class="col-5 copyable">
        <code>/api/vehicle/repairrecords/delete</code>
    </div>
    <div class="col-3">
        Deletes Repair Record
    </div>
    <div class="col-3">
        Id - Id of Repair Record
    </div>
</div>
<div class="row api-method">
    <div class="col-1">
        <span class="badge bg-success">GET</span>
    </div>
    <div class="col-5 copyable">
        <code>/api/vehicle/upgraderecords</code>
    </div>
    <div class="col-3">
        Returns a list of upgrade records for the vehicle
    </div>
    <div class="col-3">
        vehicleId - Id of Vehicle
    </div>
</div>
<div class="row api-method">
    <div class="col-1">
        <span class="badge bg-primary">POST</span>
    </div>
    <div class="col-5 copyable">
        <code>/api/vehicle/upgraderecords/add</code>
    </div>
    <div class="col-3">
        Adds Upgrade Record to the vehicle
    </div>
    <div class="col-3">
        vehicleId - Id of Vehicle
        <br />
        Body(form-data): {<br />
        date - Date to be entered<br />
        odometer - Odometer reading<br />
        description - Description<br />
        cost - Cost<br />
        notes - notes(optional)<br />
        tags - tags separated by space(optional)<br />
        extrafields - <a class="link-body-emphasis link-offset-2 link-underline-opacity-25 link-underline-opacity-100-hover reminder-calendar-item" onclick="showExtraFieldsInfo()">extrafields(optional)</a><br />
        files - <a class="link-body-emphasis link-offset-2 link-underline-opacity-25 link-underline-opacity-100-hover reminder-calendar-item" onclick="showAttachmentsInfo()">attachments(optional)</a><br />
        }
    </div>
</div>
<div class="row api-method">
    <div class="col-1">
        <span class="badge text-bg-warning">PUT</span>
    </div>
    <div class="col-5 copyable">
        <code>/api/vehicle/upgraderecords/update</code>
    </div>
    <div class="col-3">
        Updates Upgrade Record
    </div>
    <div class="col-3">
        Body(form-data): {<br />
        Id - Id of Upgrade Record<br />
        date - Date to be entered<br />
        odometer - Odometer reading<br />
        description - Description<br />
        cost - Cost<br />
        notes - notes(optional)<br />
        tags - tags separated by space(optional)<br />
        extrafields - <a class="link-body-emphasis link-offset-2 link-underline-opacity-25 link-underline-opacity-100-hover reminder-calendar-item" onclick="showExtraFieldsInfo()">extrafields(optional)</a><br />
        files - <a class="link-body-emphasis link-offset-2 link-underline-opacity-25 link-underline-opacity-100-hover reminder-calendar-item" onclick="showAttachmentsInfo()">attachments(optional)</a><br />
        }
    </div>
</div>
<div class="row api-method">
    <div class="col-1">
        <span class="badge text-bg-danger">DELETE</span>
    </div>
    <div class="col-5 copyable">
        <code>/api/vehicle/upgraderecords/delete</code>
    </div>
    <div class="col-3">
        Deletes Upgrade Record
    </div>
    <div class="col-3">
        Id - Id of Upgrade Record
    </div>
</div>
<div class="row api-method">
    <div class="col-1">
        <span class="badge bg-success">GET</span>
    </div>
    <div class="col-5 copyable">
        <code>/api/vehicle/taxrecords</code>
    </div>
    <div class="col-3">
        Returns a list of tax records for the vehicle
    </div>
    <div class="col-3">
        vehicleId - Id of Vehicle
    </div>
</div>
<div class="row api-method">
    <div class="col-1">
        <span class="badge bg-success">GET</span>
    </div>
    <div class="col-5 copyable">
        <code>/api/vehicle/taxrecords/check</code>
    </div>
    <div class="col-3">
        Updates Outdated Recurring Tax Records
    </div>
    <div class="col-3">
        No Params
    </div>
</div>
<div class="row api-method">
    <div class="col-1">
        <span class="badge bg-primary">POST</span>
    </div>
    <div class="col-5 copyable">
        <code>/api/vehicle/taxrecords/add</code>
    </div>
    <div class="col-3">
        Adds Tax Record to the vehicle
    </div>
    <div class="col-3">
        vehicleId - Id of Vehicle
        <br />
        Body(form-data): {<br />
        date - Date to be entered<br />
        description - Description<br />
        cost - Cost<br />
        notes - notes(optional)<br />
        tags - tags separated by space(optional)<br />
        extrafields - <a class="link-body-emphasis link-offset-2 link-underline-opacity-25 link-underline-opacity-100-hover reminder-calendar-item" onclick="showExtraFieldsInfo()">extrafields(optional)</a><br />
        files - <a class="link-body-emphasis link-offset-2 link-underline-opacity-25 link-underline-opacity-100-hover reminder-calendar-item" onclick="showAttachmentsInfo()">attachments(optional)</a><br />
        }
    </div>
</div>
<div class="row api-method">
    <div class="col-1">
        <span class="badge text-bg-warning">PUT</span>
    </div>
    <div class="col-5 copyable">
        <code>/api/vehicle/taxrecords/update</code>
    </div>
    <div class="col-3">
        Updates Tax Record
    </div>
    <div class="col-3">
        Body(form-data): {<br />
        Id - Id of Tax Record<br />
        date - Date to be entered<br />
        description - Description<br />
        cost - Cost<br />
        notes - notes(optional)<br />
        tags - tags separated by space(optional)<br />
        extrafields - <a class="link-body-emphasis link-offset-2 link-underline-opacity-25 link-underline-opacity-100-hover reminder-calendar-item" onclick="showExtraFieldsInfo()">extrafields(optional)</a><br />
        files - <a class="link-body-emphasis link-offset-2 link-underline-opacity-25 link-underline-opacity-100-hover reminder-calendar-item" onclick="showAttachmentsInfo()">attachments(optional)</a><br />
        }
    </div>
</div>
<div class="row api-method">
    <div class="col-1">
        <span class="badge text-bg-danger">DELETE</span>
    </div>
    <div class="col-5 copyable">
        <code>/api/vehicle/taxrecords/delete</code>
    </div>
    <div class="col-3">
        Deletes Tax Record
    </div>
    <div class="col-3">
        Id - Id of Tax Record
    </div>
</div>
<div class="row api-method">
    <div class="col-1">
        <span class="badge bg-success">GET</span>
    </div>
    <div class="col-5 copyable">
        <code>/api/vehicle/gasrecords</code>
    </div>
    <div class="col-3">
        Returns a list of gas records for the vehicle
    </div>
    <div class="col-3">
        vehicleId - Id of Vehicle
        <br />
        useMPG(bool) - Use Imperial Units and Calculation
        <br />
        useUKMPG(bool) - Use UK Imperial Calculation
    </div>
</div>
<div class="row api-method">
    <div class="col-1">
        <span class="badge bg-primary">POST</span>
    </div>
    <div class="col-5 copyable">
        <code>/api/vehicle/gasrecords/add</code>
    </div>
    <div class="col-3">
        Adds Gas Record to the vehicle
    </div>
    <div class="col-3">
        vehicleId - Id of Vehicle
        <br />
        Body(form-data): {<br />
        date - Date to be entered<br />
        odometer - Odometer reading<br />
        fuelConsumed - Fuel Consumed<br />
        cost - Cost<br />
        isFillToFull(bool) - Filled To Full<br />
        missedFuelUp(bool) - Missed Fuel Up<br />
        notes - notes(optional)<br />
        tags - tags separated by space(optional)<br />
        extrafields - <a class="link-body-emphasis link-offset-2 link-underline-opacity-25 link-underline-opacity-100-hover reminder-calendar-item" onclick="showExtraFieldsInfo()">extrafields(optional)</a><br />
        files - <a class="link-body-emphasis link-offset-2 link-underline-opacity-25 link-underline-opacity-100-hover reminder-calendar-item" onclick="showAttachmentsInfo()">attachments(optional)</a><br />
        }
    </div>
</div>
<div class="row api-method">
    <div class="col-1">
        <span class="badge text-bg-warning">PUT</span>
    </div>
    <div class="col-5 copyable">
        <code>/api/vehicle/gasrecords/update</code>
    </div>
    <div class="col-3">
        Updates Gas Record
    </div>
    <div class="col-3">
        Body(form-data): {<br />
        Id - Id of Gas Record<br />
        date - Date to be entered<br />
        odometer - Odometer reading<br />
        fuelConsumed - Fuel Consumed<br />
        cost - Cost<br />
        isFillToFull(bool) - Filled To Full<br />
        missedFuelUp(bool) - Missed Fuel Up<br />
        notes - notes(optional)<br />
        tags - tags separated by space(optional)<br />
        extrafields - <a class="link-body-emphasis link-offset-2 link-underline-opacity-25 link-underline-opacity-100-hover reminder-calendar-item" onclick="showExtraFieldsInfo()">extrafields(optional)</a><br />
        files - <a class="link-body-emphasis link-offset-2 link-underline-opacity-25 link-underline-opacity-100-hover reminder-calendar-item" onclick="showAttachmentsInfo()">attachments(optional)</a><br />
        }
    </div>
</div>
<div class="row api-method">
    <div class="col-1">
        <span class="badge text-bg-danger">DELETE</span>
    </div>
    <div class="col-5 copyable">
        <code>/api/vehicle/gasrecords/delete</code>
    </div>
    <div class="col-3">
        Deletes Gas Record
    </div>
    <div class="col-3">
        Id - Id of Gas Record
    </div>
</div>
<div class="row api-method">
    <div class="col-1">
        <span class="badge bg-success">GET</span>
    </div>
    <div class="col-5 copyable">
        <code>/api/vehicle/reminders</code>
    </div>
    <div class="col-3">
        Returns a list of reminders for the vehicle
    </div>
    <div class="col-3">
        vehicleId - Id of Vehicle
    </div>
</div>
<div class="row api-method">
    <div class="col-1">
        <span class="badge bg-success">GET</span>
    </div>
    <div class="col-5 copyable testable">
        <code>/api/calendar</code>
    </div>
    <div class="col-3">
        Returns reminder calendar in ICS format
    </div>
    <div class="col-3">
        No Params
    </div>
</div>
<div class="row api-method">
    <div class="col-1">
        <span class="badge bg-primary">POST</span>
    </div>
    <div class="col-5 copyable">
        <code>/api/documents/upload</code>
    </div>
    <div class="col-3">
        Upload Documents
    </div>
    <div class="col-3">
        Body(form-data): {<br />
        documents[] - Files to Upload<br />
        }
    </div>
</div>
@if (User.IsInRole(nameof(UserData.IsRootUser)))
{
    <div class="row api-method">
        <div class="col-1">
            <span class="badge bg-success">GET</span>
        </div>
        <div class="col-5 copyable testable" data-testparam="?urgencies=NotUrgent&urgencies=VeryUrgent&urgencies=Urgent&urgencies=PastDue">
            <code>/api/vehicle/reminders/send</code>
        </div>
        <div class="col-3">
            Send reminder emails out to collaborators based on specified urgency.
        </div>
        <div class="col-3">
            (must be root user)<br />
            urgencies[]=[NotUrgent,Urgent,VeryUrgent,PastDue]
        </div>
    </div>
    <div class="row api-method">
        <div class="col-1">
            <span class="badge bg-success">GET</span>
        </div>
        <div class="col-5 copyable testable">
            <code>/api/makebackup</code>
        </div>
        <div class="col-3">
            Creates a snapshot/backup of the DB at the time and returns a URL to download it.
        </div>
        <div class="col-3">
            No Params(must be root user)
        </div>
    </div>
    <div class="row api-method">
        <div class="col-1">
            <span class="badge bg-success">GET</span>
        </div>
        <div class="col-5 copyable testable">
            <code>/api/cleanup</code>
        </div>
        <div class="col-3">
            Clears out temp files. Deep clean will also delete unlinked thumbnails and documents. Returns number of deleted files.
        </div>
        <div class="col-3">
            (must be root user)<br />
            deepClean(bool) - Perform deep clean
        </div>
    </div>
}
<script>
    $('.copyable').on('click', function (e) {
        if (e.ctrlKey || e.metaKey){
            let targetElement = $(e.currentTarget);
            if (targetElement.hasClass("testable")){
                if (targetElement.attr("data-testparam")){
                    window.location = `${targetElement.text().trim()}${targetElement.attr("data-testparam")}`;
                } else {
                    window.location = targetElement.text().trim();
                }
            }
        } else {
            copyToClipboard(e.currentTarget);
        }
    })
    function showExtraFieldsInfo(){
        Swal.fire({
            title: "Format for Extra Fields",
            html: "extrafields[i][name] - Name of Extra Field<br/>extrafields[i][value] - Value of Extra Field<br/>i is an integer that starts at 0 and increments with each extrafield",
            icon: "info"
        });
    }
    function showAttachmentsInfo(){
        Swal.fire({
            title: "Attaching Files",
            html: "The Document Upload Endpoint will upload the files and provide a formatted output which you can pass into this method",
            icon: "info"
        });
    }
</script>