Skip to main content

DRIVER

👷🏼 Technical Specification: Driver Setup


📋 Feature Overview

Attribute Detail
Module 📂 Directory (DRIVER)
Feature Name Driver Management
Description Manages driver profiles, personal details, licensing (GDL, Passport), and bank beneficiary info. Handles system user creation for Driver PWA access.
Page & Detail
1. Listing Page: /listing-driver-manage
Displays grid of drivers, filters, delete actions, and navigation to sub-pages.
2. Add/Edit Page: /add-driver-manage
Form for creating new drivers, updating details, and linking system users.
3. Bank Info Page: /add-driver-bank-info
Additional function in driver setup for managing beneficiary details.
User Guide 📄 [Ekajaya Admin User Guide - Directory Module, Section 2]

🛠️ Technical Implementation

A. Permissions & Access Control

Note: Access is controlled via PermissionGuard and component-level checks.
Scope Permission Code Description & Page Usage
Menu Visibility DRIVER.MENU

Sidebar menu visibility for 
\listing-driver-manage

\add-driver-manage
Page Routing DRIVER.LISTING Access to listing route.
\listing-driver-manage
Page Routing DRIVER.VIEW

Access to add/edit route.

\add-driver-manage
Add Permission DRIVER.UPDATE Controls the + Add button visibility.
\listing-driver-manage
View Permission DRIVER.VIEW

Access to the Driver Listing.

\listing-driver-manage
Delete Permission DRIVER.DELETE Visibility of the Delete 🗑️ icon.
\listing-driver-manage
Bank Info View Permission DRIVER_BANK_INFO.VIEW Visibility of the Bank icon in listing.
\listing-driver-manage
Edit/Save Permission DRIVER.UPDATE Ability to save changes on Add/Edit page.
\add-driver-manage

B. API Interaction

Base URL: ${environment.baseApiUrl}
1. Retrieve Driver List \listing-driver-manage
GetList List& Search
/drivers/getQuery
POST
2. Retrieve Company Name \listing-driver-manage
Get Company NameFilter
/companies/getQuery
POST
3. Check Driver In Carriers \listing-driver-manage
Get Driver ID
/carriers/getQuery
POST
4. Delete Driver \listing-driver-manage
Delete
/drivers/update
POST
4. Get Single Driver (Edit Mode) \add-driver-manage
Get Single
/drivers/getQuery
POST
5. Create/Update Driver Profile \add-driver-manage
Create
/drivers/create
POST
Update
/drivers/update
POST
6. User Activation (Driver App Access) \add-driver-manage
Create User
/admin/createUser
POST
Link User
/drivers/update (with userId)
POST
Detach User
/driver/detachDriver
POST
7. Helper APIs (Dropdowns) \add-driver-manage
Companies
/companies/getQuery
POST
Nationalities
/settings/getQuery
POST
Address
/states/getQuery, /districts/getQuery
POST
Back to top