API Reference

MokoSuiteTaxi exposes REST API endpoints through the Joomla webservices plugin system.

Authentication

All API requests require Joomla API authentication (token-based or session-based).

Base URL

/api/index.php/v1/mokosuitetaxi

Endpoints

Rides

Method	Endpoint	Description
GET	/rides	List rides with filtering
GET	/rides/{id}	Get ride details
POST	/rides	Request a new ride
PATCH	/rides/{id}	Update ride status
DELETE	/rides/{id}	Cancel a ride

Ride Filters

status -- Filter by ride status
driver_id -- Filter by assigned driver
rider_contact_id -- Filter by rider
ride_type -- Filter by ride type
date_from / date_to -- Date range filter

Vehicles

Method	Endpoint	Description
GET	/vehicles	List vehicles
GET	/vehicles/{id}	Get vehicle details
POST	/vehicles	Register a vehicle
PATCH	/vehicles/{id}	Update vehicle
DELETE	/vehicles/{id}	Remove vehicle

Drivers

Method	Endpoint	Description
GET	/drivers	List drivers
GET	/drivers/{id}	Get driver details
POST	/drivers	Register a driver
PATCH	/drivers/{id}	Update driver
DELETE	/drivers/{id}	Deactivate driver

Zones

Method	Endpoint	Description
GET	/zones	List zones
GET	/zones/{id}	Get zone details
POST	/zones	Create zone
PATCH	/zones/{id}	Update zone
DELETE	/zones/{id}	Delete zone

Fares

Method	Endpoint	Description
GET	/fares	List fare rules
GET	/fares/{id}	Get fare rule
POST	/fares	Create fare rule
PATCH	/fares/{id}	Update fare rule
DELETE	/fares/{id}	Delete fare rule

Dispatch

Method	Endpoint	Description
GET	/dispatch	List dispatch records
GET	/dispatch/{id}	Get dispatch details

Shifts

Method	Endpoint	Description
GET	/shifts	List shifts
GET	/shifts/{id}	Get shift details
POST	/shifts	Start a shift
PATCH	/shifts/{id}	End/update shift

Response Format

All responses follow the Joomla API JSON:API specification:

{
  "data": {
    "type": "rides",
    "id": "42",
    "attributes": {
      "ride_ref": "TX1a2b3c",
      "status": "completed",
      "total_fare": 25.50
    }
  }
}

List endpoints return paginated results:

{
  "data": [...],
  "links": {
    "self": "/api/...",
    "next": "/api/...?page=2"
  }
}

Error Responses

Code	Description
400	Invalid request data
401	Authentication required
403	Insufficient permissions
404	Resource not found
409	Conflict (e.g., driver already on a ride)
422	Validation error

Pages