Data Model

User

Attribute	Description	Type	Optional	Example Value
id	Internal UUID for user	UUID	No	A3659CFF-B022-44E6-BC66-D54A05976BB5
username	Username for user	String	No	[email protected]
password_hash	Salted and hashed user password	String	No	$p5k2$$salt$syOsb4o36zs2I2yEM4m32Ems9AWRIoOR
role	Users role. One of NAVIGATOR, LANDLORD, ADMIN	String	No	NAVIGATOR
role_id	Navigator or Landlord ID	UUID	No	A3659CFF-B022-44E6-BC66-D54A05976BB5
is_admin	Is the user an admin	Boolean	No	No

Landlord

Attribute	Description	Type	Optional	Example Value
id	Internal UUID for user	UUID	No	A3659CFF-B022-44E6-BC66-D54A05976BB5
first_name	First name of the landlord	String	No	Bob
last_name	Last name of the landlord	String	No	Landlord
phone_number	Phone number in format 1-xxx-xxx-xxxx	String	Yes, but must have either a phone or email	1-434-555-1212
email_address	Email of the landlord in format [email protected]	String	Yes, but must have either a phone or email	[email protected]
company	Where the landlord works	String	Yes	York Real Estate
preferred_navigators	List of navigator IDs	Array	Yes	['A3659CFF-B022-44E6-BC66-D54A05976BB5','A8CB2BD1-2785-4A62-8841-C8E4D039B640']

Navigator

TODO

Property

Attribute	Description	Type	Optional	Example Value
id	Internal UUID for user	UUID	No	A3659CFF-B022-44E6-BC66-D54A05976BB5
landlord_id	ID of the landlord associated with the property	UUID	Yes	A3659CFF-B022-44E6-BC66-D54A05976BB5
navigator_id	ID of the landlord or navigator	UUID	Yes	A8CB2BD1-2785-4A62-8841-C8E4D039B640
voucher_type_accepted	List of government vouchers accepted	Array	Yes	['CSRAP','HCV','MSV']
voucher_type_not_accepted	List for government vouchers not accepted	Array	Yes	['voucher4','voucher5']
address	The address of the property	String	No	1111 Main St
zip_code	Zip code of the property	String	No	22901
unit_apt_no	Unit or Apartment Number	String	Yes	Apt B
property_name	Name of property (if multi-unit complex)	String	Yes	Flats
bus_line	Is there a bus line near the property	Boolean	Yes	No
school_district	The name of the school district	String	Yes	Albermarle
wheelchair_accessibility	If the property is wheelchair friendly	Boolean	Yes	Yes
elevator	If the property has an elevator	Boolean	Yes	Yes
monthly_rent	Monthly rent of the property	Number	Yes	1000
contact_method	List of contact methods	Array	Yes	['phone','email']
is_available	Is the property currently available	Boolean	No	Yes
date_first_available	Date when the property will become available in the future	Date	Yes	04/01/2020
last_contact_date	Last date which the renter of the property was contacted	Date	Yes	02/01/2020
potential_month_available	The potential months available	Number	Yes	12
bedrooms	Number of bedrooms in the property	Number	No	3
bathrooms	Number of bathrooms in the property	Number	No	1
shared_bathrooms	Number of bathrooms shared with another property	Number	Yes	1
has_basement	Does the property have a basement	Boolean	Yes	No
application_fee	Fee for filing an application	Number	Yes	24.99
deposit	Amount of money required for a deposit	Number	Yes	800.00
last_month_rent_required	Is the last month's rent required up front?	Boolean	Yes	No
allow_crimnal_records	Can tenants have a criminal records	Boolean	Yes	Yes
listing_date	Date when the property was listed	Date	No	12/09/2019
where_listed	Other locations where the property was listed	Array	Yes	['zillow','craigslist']
floor	Building floor which the property is on	Number	Yes	2
housing_type	Type of housing	String	Yes	Apartment
year_available	Year that he property is listed an available	Number	Yes	2020
credit_screening_company	Name of the company used to screen applicants credit scores	String	Yes	creditrating.com
background_screening_company	Name of company used to screen the applicants background	String	Yes	background-screening.com
last_contacted_by	ID of the last navigator to make contact regarding the property	UUID	Yes	A8CB2BD1-2785-4A62-8841-C8E4D039B640

Note

Attribute	Description	Type	Optional	Example Value
id	Internal UUID for user	UUID	No	A3659CFF-B022-44E6-BC66-D54A05976BB5
entity_type	Entity type which this note is attached to. One of: LANDLORD, USER, PROPERTY	String	No	PROPERTY
entity_id	ID of the entity which this note is attached to	UUID	No	A8CB2BD1-2785-4A62-8841-C8E4D039B640
created_by	ID of the user who created the note	UUID	No	A8CB2BD1-2785-4A62-8841-C8E4D039B640
content	Content of the note	String	Yes	This is my note
private	Whether this note is private and only visible to the creator and admin	Boolean	No	No
created_at	Timestamp when the note was created	Timestamp	No	03/01/2020T0000000Z