Skip to content

Business Endpoint Documentation

Tareq Kirresh edited this page May 7, 2018 · 1 revision

Business Endpoints

Vehicle Checking

PUT /vehicle/checking/{vehicle_id} --> Attempt to checkout a vehicle.

POST /vehicle/checking/ --> checkin a vehicle.

Vehicle Tracking

GET /vehicle/location/ --> List all vehicle locations.

GET /vehicle/location/{vehicle_id} --> Read a vehicle location.

POST /vehicle/location/ --> update the location of the vehicle you have checked out,

Vehicle Statuses

GET /vehicle/status/ --> List all vehicle statuses.

GET /vehicle/status/{vehicle_id} --> Read the status of a vehicle.

UPDATE /vehicle/status/{vehicle_id} --> Update the status of a vehicle.

Vehicle Dispatch

GET /vehicle/dispatch/ --> Get all current dispatch orders.

GET /vehicle/dispatch/{vehicle_id} --> Get the dispatch order on a specific vehicle.

PUT /vehicle/dispatch/{vehicle_Id} --> Create a new dispatch order for this vehicle.

DELETE /vehicle/dispatch/{order_id} --> Delete(cancel) a dispatch order.

Dispatcher Notifications

GET /user/dispatcher/notifications/ --> Get all notifications that haven't been handled.

GET /user/dispatcher/notifications/{area_id} --> Get all notifications of an area that havent been handled.

PUT /user/dispatcher/notifications/{notification_id} --> Respond to a particular notification.

External API Endpoint

GET /api/ --> List all unanswered notifications.

POST /api/ --> Send a new request for a dispatch order.

GET /api/{notification_id} --> read the status and information of a notification.

Drivers

GET /user/driver/ --> List all drivers(personal details only)

GET /user/driver/{driver_id} --> Read a particular driver(personal details only)