lytes20 / bootcamp-challenge-3

maintenance tracker api

About

Maintenance Tracker App is an application that provides users with the ability to reach out to operations or repairs department regarding repair or maintenance requests and monitor the status of their request.

This API for the maintenance tracker application allows users and admins to have the mentioned functionality above

Features

• Register a user
• Login a user
• Get all the requests for a logged in user
• Get a request for a logged in user
• Create a request.
• Modify a request
• Approve a request
• Disapprove a request
• Resolve a request

Tools Used

• Flask - web microframework for Python
• Virtual environment - tool used to create isolated python environments
• pip - tool used used to install python messages
• git - free open source distributed version control system

Requirements

Python 3.x.x+

Run (Use) on your local machine

First clone the repository

   $ git clone https://github.com/lytes20/maintenance-tracker-api.git

Head over to the cloned directory, create a virtual environment, use pip to install the requirements, the run the app

 $ cd maintenance-tracker-api
 $ virtualenv venv
 $ source venv/Scripts/activate
 $ pip install -r requirements.txt
 $ python run.py

Note If you are using a unix operating system, use: $ source venv/bin/activate

Endpoints to create a user account and login into the application

HTTP Method	End point	Public Access	Action
POST	api/v1/user/register	True	Create an account
POST	api/v1/user/login	True	Login a user

Endpoints to create, read and update user requests

HTTP Method	End point	Public Access	Action
POST	api/v1/users/requests	True	Create a request
GET	api/v1/users/requests	False	Fetch requests for a logged in user
GET	api/v1/users/requests	False	Fetch requests for a logged in user
GET	api/v1/users/requests/requestid	False	Fetch a request for a logged in user
PUT	api/v1/users/requests/requestid	False	Update a request for a logged in user
PUT	api/v1/requests/requestId/approve	False	Approve a user request
PUT	api/v1/requests/requestId/disapprove	False	disapprove a user request
PUT	api/v1/requests/requestId/resolve	False	resolve a user request

Authors

Bamuleseyo Gideon