Vehicle Module
The Vehicle Sharing module (shortened Vehicle) is the main repository for master data about vehicles and their sharing.
It handles vehicle maintenance, trip proposals, zone checks, on-board-device interactions and vehicle movement rules.
Admin Interface
The Admin interface handles web service calls from the Admin web gui. The base url for this is at:
/api/vehicle-admin/
A JSON file with OpenAPI data about all vehicle-related admin APIs can be downloaded here.
Select a topic from the list below.
- Vehicle - Vehicles
- Get vehicle description
- Get vehicle description by Guid
- Get vehicle trips
- Get vehicles
- Get vehicles in area
- Get vehicle by device
- Add or Update vehicle
- Delete vehicle
- Set operative
- Override system operativity
- Relocate
- Set vehicle cleaning statuses
- Get vehicle device metric
- Get available vehicles
- Get vehicle groups
- Add vehicles to group
- Get zones
- Get vehicle damages
- Gets vehicles out of zone
- Get vehicles far from zones
- Get vehicles moving without trips
- Get attention needed vehicles
- Get Scheduled Operations for the Vehicle
- Get Maintenance Operations for the Vehicle
- Get vehicle metrics list
- Vehicle - Additional Vehicle Data
- Vehicle - Categories
- Vehicle - Communities
- Vehicle - Groups
- Vehicle - Group Constraints
- Vehicle - Devices
- Vehicle - Drivers
- Vehicle - Garages
- Vehicle - Zones
- Vehicle - Points of Interest
- Vehicle - Damage Reports
- Vehicle - Maintenance
- Get Vehicle Schedules
- Get one Vehicle Schedule
- Check if a Vehicle Schedule can be made
- Add a Vehicle Schedule or update an existing one
- Delete a Vehicle Schedule
- Get Maintenance Operations
- Get one Maintenance Operation
- Add a Maintenance Operation or update an existing one
- Delete a Maintenance Operation
- Mark a Maintenance Operation as completed
- Get Maintenance Operation Damage Reports
- Get the list of rows for a Maintenance Operation
- Get one Maintenance Operation Row
- Add a Maintenance Operation Row or update an existing one
- Delete a Maintenance Operation Row
- Get the list of Devices for a specified Operation
- Get Maintenance Operation Types
- Get all Maintenanbce Operation Types
- Add a Maintenance Operation Type or update an existing one
- Delete a Maintenance Operation Type
- Vehicle - Movement Authorities
- Vehicle - Billable Trips
- Vehicle - Filters
- Vehicle - Movement Rules
- Vehicle - Availability Rules
- Vehicle - Attachments
- Vehicle - Config
- Vehicle - System
Statistics Interface
This interface allows for access to statistics data. The base url for this interface is at:
/api/vehicle-statistics/
A JSON file with OpenAPI data about all vehicle-related statistics APIs can be downloaded here.
A valid JWT is required for all statistics access.
Select a topic from the list below.