transport-passenger

Assignment Database System - Transport Passenger

Project maintained by huynhsamha Hosted on GitHub Pages — Theme by huynhsamha

APIs

All APIs need token after login to system to use.

To avoid login to use api for development, you can create auth secret in file .env, which is added to the request as body or query to pass the authentication layer.

Example, in file .env, add:

AUTHENTICATION_SECRET=F3yqfrVHR3cLDYdqpQLVZus549aXLrWTsDGsddVARSSPCBw5GAa6VGafxAdh4Mac9cP93PbNheL7BxzRPMMH36h5VuB7ks5xbZMDUHczZQc82ra6UMkbEE9zQtDRYvqNHSUn8UVySaSEDQLtz2RYHhQQnA7rjAahZKY4sGh6B5exnL7SD8fbGe8cPhSHYXFbDMZtaSseMQsYUT76BMEGANCxZxy2hCYRB4JVXVrqpjTT48BWRcuX6uqZ8kuKNCZhEF7L6emrTgQLCfWh436WPA3rQKLw39exaAZbwstCuGqd7SmeXgnZkXmnhBu3GhhJdsVdf5bce4yHTrUQhjKCeUb3vFxMMtCEHQGzx6C5bz7ewjtFZnB8ngXcPCGkJcGmaUpAVJUFdfwKwME8Dyz9HQmDeAHNpWUn3XQpa97TKfJZ8Zue2VNqV93SnS8qMmV9cfvye2YVSzJJ65rUPDnHVbvPDp69BEJe4UNeYJ9WRnDy4EFqz4ZFdjF8z6wtQRQc

In request, for post or put, you add to body with authSecret, for get or delete, you add to query with authSecret (authSecret is the AUTHENTICATION_SECRET you added)

Method	Url	Description
POST	/api/auth/signIn/	req.body: { username, password } res.status: + 500 => { errorMessage } + 404 => { message: ‘User not found’ } + 401 => { message: ‘Wrong password’ } + 200 => { user, token }
POST	/api/auth/forgotPassword/	req.body: { email } res.status: + 500 => { errorMessage } + 404 => { message: ‘User not found’ } + 200 => { message: ‘check email’ }
POST	/api/auth/resetPassword/	req.body: { token, password } res.status: + 500 => { errorMessage } + 403 => { message: ‘Token is not valid’ } + 200 => { message: ‘successfully’ }
GET	/api/signOut/	header[‘x-access-token’] response: redirect to ‘/’

After login, you should store token in reponse, and use it in req.body.tokne or req.query.token or req.header['x-access-token'] to use following APIs

BUS_TYPE

Method	Url	Description
GET	/api/v1/busType/	query: { offset: default 0, limit: default 100 } response: { data: [{},…] }
POST	/api/v1/busType/
GET	/api/v1/busType/:id	response: { data: {} }
PUT	/api/v1/busType/:id
DELETE	/api/v1/busType/:id
GET	/api/v1/busType/:id/buses	query: { offset, limit } response: { data: [{},…]}

BUS

Method	Url	Description
GET	/api/v1/bus/	query: { offset: default 0, limit: default 100 } response: { data: [{ …, bus_type: {} }] }
POST	/api/v1/bus/
GET	/api/v1/bus/:id	response: { data: { …, bus_type: {} } }
PUT	/api/v1/bus/:id
DELETE	/api/v1/bus/:id

TRIP_DAILY

Method	Url	Description
GET	/api/v1/tripDaily/	query: { offset: default 0, limit: default 100 }
POST	/api/v1/tripDaily/
GET	/api/v1/tripDaily/:id
PUT	/api/v1/tripDaily/:id
DELETE	/api/v1/tripDaily/:id
GET	/api/v1/tripDaily/:id/trips	Get list of trips which trip daily `:id`

TRIP

Method	Url	Description
GET	/api/v1/trip/	query: { offset: default 0, limit: default 100 }
POST	/api/v1/trip/
GET	/api/v1/trip/:id
PUT	/api/v1/trip/:id
DELETE	/api/v1/trip/:id

OFFICE

Method	Url	Description
GET	/api/v1/office/	query: { offset: default 0, limit: default 100, is_headequater: true } response: if (is_headquater: true) { data: {} } else { data: [{}] }
POST	/api/v1/office/
GET	/api/v1/office/:id	response: { data: {} }
PUT	/api/v1/office/:id
DELETE	/api/v1/office/:id

EMPLOYEE

Method	Url	Description
GET	/api/v1/employee/	query: { offset: default 0, limit: default 100 } response: { data: [{}] }
POST	/api/v1/employee/
GET	/api/v1/employee/:id	query: { supervisor: true, department: true} response: { data: {…, (supervisor: {}), (department: {}) } }
PUT	/api/v1/employee/:id
DELETE	/api/v1/employee/:id

MANAGER

Method	Url	Description
GET	/api/v1/employee/role/manager/	query: { offset: default 0, limit: default 100 } response: { data: [{…, infomation: { employee attributes }}] }
POST	/api/v1/employee/role/manager/
GET	/api/v1/employee/role/manager/:id	query: { department: true } response: { data: {…, infomation: { employee attributes, (department: {}) }} }
PUT	/api/v1/employee/role/manager/:id
DELETE	/api/v1/employee/role/manager/:id
GET	/api/v1/employee/role/manager/:id/subordinates	query: { offset: default 0, limit: default 100 } response: { data: [{}] }

DRIVER - ASSISTANT - SELLER

Change driver to assistant or seller for correct api

Method	Url	Description
GET	/api/v1/employee/role/driver/	query: { offset: default 0, limit: default 100 }
POST	/api/v1/employee/role/driver/
GET	/api/v1/employee/role/driver/:id	query: { department: true, supervisor: true } response: { data: {…, infomation: { employee attributes, (department: {}), (supervisor: {}) }} }
PUT	/api/v1/employee/role/driver/:id
DELETE	/api/v1/employee/role/driver/:id

CITY

Method	Url	Description
GET	/api/v1/city/	query: { offset: default 0, limit: default 100 } response: { data: […, center_district: {}] }
POST	/api/v1/city/
GET	/api/v1/city/:id	response: { data: {…, center_district: {}} }
PUT	/api/v1/city/:id
DELETE	/api/v1/city/:id
GET	/api/v1/city/:id/districts	response: { data: [{},…]}
GET	/api/v1/city/:id/center_district	response: { data: {} }

DISTRICT

Method	Url	Description
GET	/api/v1/district/	query: { offset: default 0, limit: default 100 } response: { data: [{ …, city: {} }] }
POST	/api/v1/district/
GET	/api/v1/district/:id	response: { data: { …, city: {} } }
PUT	/api/v1/district/:id
DELETE	/api/v1/district/:id

TRANSACTION

Available as above

TICKET