package
1.1.10
Repository: https://github.com/cad/vehicle-tracker-api.git
Documentation: pkg.go.dev

# Functions

swagger:route POST /auth/ Auth Authorize Get an `authorization_token`.
swagger:route GET /auth/ Auth CheckAuth See if you are authenticated or not.
No description provided by the author
swagger:route POST /vehicle/group/ Vehicles CreateNewGroup Create a new vehicle group.
swagger:route POST /user/ Users CreateNewUser Create a new user.
swagger:route POST /vehicle/ Vehicles CreateNewVehicle Create a new vehicle record.
swagger:route DELETE /vehicle/group/{group_id} Vehicles DeleteVehicleGroup Delete a group definition.
swagger:route DELETE /user/{uuid} Users DeleteUser Delete a user.
swagger:route DELETE /vehicle/{plate_id} Vehicles DeleteVehicle Delete a vehicle.
swagger:route GET /agent/ Agents FilterAgents Filter vehicles.
swagger:route GET /vehicle/filter Vehicles FilterVehicles Filter vehicles in the database.
swagger:route GET /ws/vehicle/filter WebSocket FilterVehiclesWS WebSocket Endpoint for filter vehicles.
swagger:route GET /vehicle/group/ Vehicles GetAllGroups Get all vehicle groups in the database.
swagger:route GET /vehicle/type/ Vehicles GetAllTypes Get possible vehicle types defined in the system.
swagger:route GET /user/ Users GetAllUsers Get all Users.
swagger:route GET /vehicle/ Vehicles GetAllVehicles Get all vehicles in the database.
No description provided by the author
swagger:route GET /user/{uuid} Users GetUser Get a User by UUID.
swagger:route GET /vehicle/{plate_id} Vehicles GetVehicle Get a vehicle from database.
NewUUIDContext creates a new ctx with the given UUID.
swagger:route PUT /vehicle/{plate_id}/groups Vehicles SetVehicleGroups Set vehicle's groups.
swagger:route POST /agent/{uuid}/sync Agents SyncAgent Send GPS data from agent.
No description provided by the author
UUIDFromContext extracts the user UUID from ctx, if present.
swagger:route POST /vehicle/{plate_id}/agent Vehicles VehicleSetAgent Set vehicle agent.
swagger:route DELETE /vehicle/{plate_id}/agent Vehicles VehicleUnsetAgent Unset vehicle agent.

# Structs

Returns an agent swagger:response.
Returns list of agents swagger:response.
Returns empty object swagger:response.
No description provided by the author
swagger:parameters Authorize.
No description provided by the author
No description provided by the author
Returns ok if authenticated swagger:response.
Returns a `authorization_token` swagger:response.
CoordinatePair represents a location on earth swagger:model.
swagger:parameters CreateNewGroup.
swagger:parameters CreateNewUser.
swagger:parameters CreateNewVehicle.
swagger:parameters DeleteVehicleGroup.
swagger:parameters DeleteUser.
swagger:parameters DeleteVehicle.
Generic Error swagger:response ErrorMsg.
swagger:parameters FilterAgents.
swagger:parameters FilterVehicles.
swagger:parameters FilterVehiclesWS.
No description provided by the author
swagger:parameters GetUser.
swagger:parameters GetVehicle.
No description provided by the author
swagger:parameters SetVehicleGroups.
swagger:parameters SyncAgent.
swagger:parameters User.
Returns a user swagger:response.
Returns list of users swagger:response.
VehicleGroupResponse swagger:response.
VehicleResponse swagger:response.
swagger:parameters VehicleSetAgent.
Returns a vehicle group swagger:response.
Returns list of vehicle groups swagger:response.
Returns a vehicle swagger:response.
Returns list of vehicles swagger:response.
Returns list of vehicle types swagger:response.
swagger:parameters VehicleUnsetAgent.