-
Notifications
You must be signed in to change notification settings - Fork 0
/
api_guide.txt
133 lines (106 loc) · 2.33 KB
/
api_guide.txt
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
"/signUp"
method: POST
body: {
email: string,
name: string,
password: string,
degree: string,
institution: string,
image: string,
interested: array
}
return:
success(201): {email, name}
fail(400): { error: string }
signed-cookies: "user" = user
******************************************************************************
"/signIn"
method: POST
body: {
email: string,
password: string
}
return:
success(200): {email, name}
fail(400): {error: string}
signed-cookies: "user" = user
******************************************************************************
"/user/update"
method: PUT
using-signed-cookie: user
body: {
name: string,
degree: string,
institution: string,
image: string,
interested: array
}
return:
success(205): {email, name}
fail(400): {error: string}
signed-cookies: "user" = user
******************************************************************************
"/user/details"
method: GET
using-signed-cookie: user
return:
success(200): all user details
fail(400): {error: string}
******************************************************************************
"/users"
method: GET
return:
success(200): [user1, user2, ... ]
fail(400): {error: string}
******************************************************************************
"/group/create"
method: POST
using-signed-cookie: user
body:{
name: string,
course: Course,
subject: string,
studyTogether: boolean,
where: string,
institution: string,
participantsNumber: int,
description: string,
timeRanges: array,
howLong: string,
ownerId: string(email)
}
return:
success(201): group {id: int , name:string .... }(like body)
fail(400): {error: string}
******************************************************************************
"/group/{id}"
method: GET
return:
success(200): group (by id in url)
fail(400): {error: string} (including group not found)
******************************************************************************
"/group/join"
method: PUT
using-signed-cookie: user
body: {
groupId: int
}
return:
success(201): group
fail(400): {error: string}
******************************************************************************
"/groups"
method: GET
return: array {
group0,
group1,
...
}
******************************************************************************
"/courses"
method: GET
return: array {
course0,
course1,
...
}