rasky26 / rental_app

Rental_App

Rental App Info

---

Django server that works to automate as much of the apartment management process as necessary.

...

Active API's:

---

User registration: URL = /'accounts/registration'

Method: POST -> data={username, password}
Responses:
    Success -> {token, expiry}
    Error -> {registration-errors: errors: [username, password]}

Main Function	Sub Function	Route	Method	Model	View	Serializer	URL	Tests	Improvements
User Account
	Register	accounts/registration	POST	Done	Done	Done	Done	Done	Add email confirmation before approval
	Login	accounts/login	POST	Done	Done	Done	Done	Done
	Logout (current browser)	accounts/logout	POST	Done	Done	Done	Done	Done
	Logoutall (all browsers)	accounts/logoutall	POST	Done	Done	Done	Done	Done
	Change Password			Done
	Forgot Password			Done
Buildings
	Add building with NO exising company	buildings/no-company/new-building	POST	Done	Done	Done	Done	Done
	Add building with exising company	buildings/{company-pk-value}/new-building	POST	Done	Done	Done	Done	Done
	Edit a building	buildings/{building-pk-value}	PATCH	Done	Done	Done	Done	Done
	Retrieve a building		GET
	Delete a building		DELETE
Change Log
	Get list of changes		GET	Done
Companies
	Create company	companies/create	POST	Done	Done	Done	Done	Done
	Retrieve company		GET	Done
	Update company		PATCH	Done
	Delete company		DELETE	Done
	Invite Users to company	companies/invite/{company-pk-value}	POST	Done	Done	Done	Done	Done
	Upload documents to company	companies/{company-pk-value}/upload-document	POST	Done	Done	Done	Done	Done
Contacts
	Edit address		PATCH
	Edit contact		PATCH
Documents
	Edit document		PATCH
	Edit image		PATCH
General Ledger
	Create general ledger account		POST	In development					Only make GL's when new entities are made?
	Update general ledger account		PATCH	In development
	Retrieve general ledger account		GET	In development					Add functions to get cash with time / timeframes
	Delete general ledger account		DELETE	In development					Do not allow deletion, only closure
Notes
	Get & Update note	notes/{note-pk-value}	GET / PATCH	Done	Done	Done	Done	Done