roommate-backend/api.txt at main · dhp98/roommate-backend · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
register
login

/profile/
GET
req.body: {FILTERS RoomatePreference fields = similar to = Profile}
res.status(200).send(
    {
        "message": "",
        "data": {
            "users": "Send back list of Profile with userID field populated"
        }
    }
)

/profile/:userID
GET
req.body: {}
res.status(200).send(
    {
        "message": "",
        "data": {
            "profile": Profile Object. Also populate the userID field
        }
    }
)

/profile
POST
req.body: Profile schema
res.status(201).send(
    {
        "message": "",
        "data": {
            "createdProfile": Profile Object
        }
    }
)

/profile
PUT
req.body: Profile schema
res.status(201).send(
    {
        "message": "",
        "data": {
            "updatedProfile": Profile Object
        }
    }
)

----------------------------------
/apartment/
GET
req.body: {FILTERS basically apartment schema fields}
res.status(200).send(
    {
        "message": "",
        "data": {
            "apartments": Apartment List Object
        }
    }
)

/apartment/:apartmentID
GET
req.body: {}
res.status(200).send(
    {
        "message": "",
        "data": {
            "apartment": Apartment Object
        }
    }
)

/apartment
POST
req.body: Apartment schema
res.status(201).send(
    {
        "message": "",
        "data": {
            "createdApartment": Apartment Object
        }
    }
)

/apartment
PUT
req.body: Apartment schema
res.status(201).send(
    {
        "message": "",
        "data": {
            "updatedApartment": Apartment Object
        }
    }
)

/apartment/:apartmentID
DELETE
req.body: {}
res.status(200).send(
    {
        "message": "",
        "data": {}
    }
)


----------------------------------
/roomatepreference/:userID
GET
req.body: {}
res.status(200).send(
    {
        "message": "",
        "data": {
            "roomatePreference": RoomatePreference List Object
        }
    }
)


----------------------------------
/interestedapartment/:aptID
GET
req.body: {}
res.status(200).send(
    {
        "message": "",
        "data": {
            "userList": InterestedApartment object with user field populated
        }
    }
)

/interestedapartment/
POST
req.body: { aptID:"", userID:"" }
res.status(200).send(
    {
        "message": "",
        "data": {
            "interestedApartment": InterestedApartment object
        }
    }
)