Blame
| 6050dd | Hargata Softworks | 2026-01-11 19:08:19 | 1 | # Equipment |
| 2 | ||||
| 3 | Equipment Records allow you to track distance accumulated for equipment on your vehicle. | |||
| 4 | ||||
| 5 | Use cases include but not limited to: | |||
| 6 | - keeping track of seasonal tire sets | |||
| 7 | - trailers | |||
| 8 | - motorcycle sidecars | |||
| 9 | ||||
| 10 | ## Enabling Equipment Tab | |||
| 11 | ||||
| 12 |  | |||
| 13 | ||||
| 14 | ## How it works | |||
| 15 | ||||
| 16 | When you create an equipment, you have the option of marking it as "Is Equipped" | |||
| 17 | ||||
| 18 |  | |||
| 19 | ||||
| 67004e | Hargata Softworks | 2026-01-11 19:54:06 | 20 | When "Is Equipped" is selected for the equipment, it will be equipped by default when an odometer record is added, either manually or via the auto-insert when adding other records(when auto-insert is enabled), for API integration, see notes on API below. |
| 8e49f4 | Hargata Softworks | 2026-01-11 19:10:13 | 21 | |
| 22 |  | |||
| 6050dd | Hargata Softworks | 2026-01-11 19:08:19 | 23 | |
| 3cdf87 | Hargata Softworks | 2026-01-11 19:09:22 | 24 | The "Distance" column in the Equipment tab displays the total amount of distance based on the odometer records associated where the equipment is equipped. |
| 25 | ||||
| 26 |  | |||
| 27 | ||||
| 28 | ## Attaching Equipment to existing Odometer Records | |||
| 29 | ||||
| 30 | You can either edit the Odometer Records one by one or selecting multiple of them, right click and select "Edit Multiple" | |||
| 31 | ||||
| 32 |  | |||
| 33 | ||||
| 34 | Then enable "Edit Equipment" and then select the equipment | |||
| 35 | ||||
| 36 |  | |||
| 37 | ||||
| 38 | Note that "Edit Equipment" will override any equipment that was previously linked to the selected records. | |||
| 39 | ||||
| 40 | ## Note on API | |||
| 6050dd | Hargata Softworks | 2026-01-11 19:08:19 | 41 | |
| 42 | When Auto-Insert Odometer Records is enabled, calling the following endpoints will automatically insert an odometer record with any equipment marked as "Is Equipped" | |||
| 43 | ||||
| 44 | - /api/vehicle/servicerecords/add | |||
| 45 | - /api/vehicle/repairrecords/add | |||
| 46 | - /api/vehicle/upgraderecords/add | |||
| 47 | - /api/vehicle/gasrecords/add | |||
| 48 | ||||
| 49 | The `/api/vehicle/odometerrecords/add` endpoint does not automatically link equipment to the newly created odometer record. This is by design because this endpoint allows users to insert odometer records in the past, which may or may not have the equipment on it. | |||
| 50 | ||||
| 51 | If you wish to utilize the "Add Odometer Record" endpoint, you must first make an API call to `/api/vehicle/equipmentrecords` and filter the records where "isEquipped" is true, then add the ids of the equipment record as a string connected by spaces to your post object to the `/api/vehicle/odometerrecords/add` endpoint. | |||
| 52 | ||||
| 53 | Example: | |||
| 54 | ``` | |||
| 55 | { | |||
| 56 | "date": "2026-01-03", | |||
| 57 | "initialOdometer": 15000, | |||
| 58 | "odometer": 16500, | |||
| 59 | "notes": "test", | |||
| 60 | "tags": "testing", | |||
| 61 | "equipmentRecordId": "1 2 3 4 5" | |||
| 62 | } | |||
| 63 | ``` |