-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathapi_doc.txt
65 lines (39 loc) · 2.6 KB
/
api_doc.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
================================================================= Group ========================================================================
GET /groups List groups
Response: [{name, id}]
POST /groups Create new Group
Resquest: {name, office}
Response: {group_id}
DELETE /groups/{group_id} Delete specific Group
============================================================= Group Employees =================================================================
GET /groups/{group_id}/employees List Group Employees
Request: {start_date, end_date}
Response: [{yid, name, img, assignments: [{assignment_type, times}]}]
POST /groups/{group_id}/employees Employee joins Group
Resquest: {yid, ...}
DELETE /groups/{group_id}/employees/{employee_id} Employee leaves Group
GET /employees/{yid}/groups List Groups of an Employee
Response [{group_id, admin}]
GET /groups/{group_id}/employees
============================================================= Assignment Types =================================================================
GET /groups/{group_id}/assignment_types List AssignmentTypes
Response: [{id, name}]
POST /groups/{group_id}/assignment_types Create new Assignment Type
Request: {name}
DELETE /groups/{group_id}/assignment_types/{assignment_type_id} Delete Assignment Type
=============================================================== GroupDay =======================================================================
GET /assignments Get list of assignments for a certain period
Request: {group_id, start_date, final_date}
Response: [{date, assignments: [{assignment_id, assignment_type, yid, ...}]]
POST /assignments/ Assignes an Employee to a Day(Group) with an AssignmentType
Request: {date, group_id, yid, assignment_type_id}
Response: {assignment_id}
DELETE /assignments/{assignment_id} Unassigns an Employee from a Day(Group) (of a particular AssignmentType)
============================================================= Authentication ==================================================================
POST /login
Request: {yid, ...}
Response: {ytoken?, admin_global?}
POST /logout
Request: /* Session cookies */
=========================================================== Authorization Roles ===============================================================
// TODO: