-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathAPIDocumentation.yml
1170 lines (1125 loc) · 32.7 KB
/
APIDocumentation.yml
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.3
info:
title: Attendance Service API
description: |-
This is the API documentation of Attendance Service (MOSIP).
version: 1.0.0
servers:
- url: http://20.235.163.35:8080
tags:
- name: Exams
description: APIs related to exam and exam attendance
- name: Lectures
description: APIs related to lecture and lecture attendance
- name: Users
description: APIs related to user authentication/registration
- name: Halls
description: APIs related to Halls
- name: Courses
description: APIs related to Courses
paths:
/admin/exam/create:
post:
tags:
- Exams
summary: Create an exam
description: This endpoint will provide functionality to create an exam.
operationId: createExam
requestBody:
description: Exam details
content:
application/json:
schema:
$ref: '#/components/schemas/CreateExamRequestDTO'
required: true
responses:
'200':
description: Exam created successfully.
content:
application/json:
schema:
properties:
status:
type: string
example: "OK"
message:
type: string
example: "Exam created successfully"
data:
type: number
description: Exam id
example: 2
'400':
description: Invalid or missing details
security:
- access_token: [ ]
/admin/exam-attendance/{examId}:
get:
tags:
- Exams
summary: Get attendance for an exam
description: This endpoint will provide a list of enrolled students for an exam with their attendance status.
operationId: getAttendanceForAnExam
parameters:
- name: examId
in: path
description: ID of the Exam
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Attendance fetched successfully.
content:
application/json:
schema:
properties:
status:
type: string
example: "OK"
message:
type: string
example: "Attendance Fetched."
data:
type: array
items:
$ref: '#/components/schemas/ExamAttendance'
'400':
description: Invalid ID supplied or ID missing
'404':
description: Exam ID is not found.
security:
- access_token: []
/admin/exam/get-exam/{examId}:
get:
tags:
- Exams
summary: Get an exam by ID
description: This endpoint will provide details of an exam for a given exam ID.
operationId: getExamById
parameters:
- name: examId
in: path
description: ID of the Exam
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Exam fetched successfully.
content:
application/json:
schema:
properties:
status:
type: string
example: "OK"
message:
type: string
example: "Exam Fetched."
data:
$ref: '#/components/schemas/ExamDTO'
'400':
description: Invalid ID supplied or ID missing
'404':
description: Exam ID is not found.
security:
- access_token: [ ]
/admin/exam/all-exams:
post:
tags:
- Exams
summary: Get all exams
description: This endpoint will provide details of all exams of the system.
operationId: getAllExams
requestBody:
description: Time period consisting Start time and end time
content:
application/json:
schema:
$ref: '#/components/schemas/GetExamsRequestDTO'
required: false
responses:
'200':
description: Exams fetched successfully.
content:
application/json:
schema:
properties:
status:
type: string
example: "OK"
message:
type: string
example: "Exams Fetched."
data:
type: array
items:
$ref: '#/components/schemas/ExamDTO'
'404':
description: Exams not found.
security:
- access_token: [ ]
/student/exam-attendance-attendance/mark-exam-attendance:
post:
tags:
- Exams
summary: Mark and verify attendance for a exam
description: This endpoint will provide functionality for a student to mark and verify their attendance in a exam and display their details.
operationId: markExamAttendance
requestBody:
description: Biometric credentials and exam id
content:
application/json:
schema:
$ref: '#/components/schemas/MarkAttendanceRequestDTO'
required: true
responses:
'200':
description: Attendance marked successfully.
content:
application/json:
schema:
properties:
status:
type: string
example: "OK"
message:
type: string
example: "Attendance marked successfully"
data:
$ref: '#/components/schemas/StudentDTO'
'400':
description: Invalid or missing details
content:
application/json:
schema:
properties:
status:
type: string
example: "INVALID_DATA"
message:
type: string
example: "Student does not have access to this exam"
security:
- access_token: [ ]
/admin/login:
post:
tags:
- Users
summary: Authenticate users
description: Authenticate the users and receive an access token
operationId: login
requestBody:
description: Login details
content:
application/json:
schema:
$ref: '#/components/schemas/LoginRequestDTO'
required: true
responses:
'200':
description: Returns the access token after successfully authentication
content:
application/json:
schema:
$ref: '#/components/schemas/AccessTokenDTO'
'400':
description: Invalid inputs/ Missing inputs/ Invalid grant type
'401':
description: Invalid credentials
'404':
description: Username not found
/admin/lecture-attendance/student/{studentId}:
get:
tags:
- Users
summary: Get lecture attendance of a student
description: This endpoint will provide functionality for a admin to get the lecture attendance history of a student.
operationId: getStudentAttendance
parameters:
- name: studentId
in: path
description: ID of the student
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Student attendance fetched successfully.
content:
application/json:
schema:
properties:
status:
type: string
example: "OK"
message:
type: string
example: "Student Attendance Fetched"
data:
type: array
items:
$ref: '#/components/schemas/StudentLectureAttendanceDTO'
'400':
description: Invalid or missing details
content:
application/json:
schema:
properties:
status:
type: string
example: "INVALID_DATA"
message:
type: string
example: "Student id not found"
security:
- access_token: [ ]
/admin/lecture-attendance/lecture/{lectureId}:
get:
tags:
- Users
summary: Get student attendance of a lecture
description: This endpoint will provide functionality for a admin to get the student attendance of a lecture.
operationId: getAttendanceForLecture
parameters:
- name: lectureId
in: path
description: ID of the lecture
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Lecture attendance fetched successfully.
content:
application/json:
schema:
properties:
status:
type: string
example: "OK"
message:
type: string
example: "Lecture Attendance Fetched By Lecture ID"
data:
type: array
items:
$ref: '#/components/schemas/LectureAttendanceDTO'
'400':
description: Invalid or missing details
content:
application/json:
schema:
properties:
status:
type: string
example: "LECTURE_ID_NOT_FOUND"
message:
type: string
example: "Lecture ID is not found."
security:
- access_token: [ ]
/admin/lecture/create:
post:
tags:
- Lectures
summary: Create a lecture
description: This endpoint will provide functionality for a admin to create a lecture.
operationId: create
requestBody:
description: Lecture details
content:
application/json:
schema:
$ref: '#/components/schemas/CreateLectureRequestDTO'
required: true
responses:
'200':
description: Lecture created successfully.
content:
application/json:
schema:
properties:
status:
type: string
example: "LECTURE_CREATED_SUCCESSFULLY"
message:
type: string
example: "Lecture created successfully!"
data:
type: number
description: Lecture id
example: 2
'400':
description: Invalid or missing details
security:
- access_token: [ ]
/admin/lecture/start-lecture/{lectureId}:
get:
tags:
- Lectures
summary: Start a lecture
description: This endpoint will provide functionality for a admin to start a lecture.
operationId: startLecture
parameters:
- name: lectureId
in: path
description: ID of the lecture
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Lecture started successfully.
content:
application/json:
schema:
properties:
status:
type: string
example: "OK"
message:
type: string
example: "Lecture started successfully"
data:
type: integer
format: int64
description: "Lecture id"
example: 43872
'400':
description: Invalid or missing details
content:
application/json:
schema:
properties:
status:
type: string
example: "INVALID_DATA"
message:
type: string
example: "Lecture already started"
security:
- access_token: [ ]
/admin/lecture/end-lecture/{lectureId}:
get:
tags:
- Lectures
summary: End a lecture
description: This endpoint will provide functionality for a admin to end a lecture.
operationId: endLecture
parameters:
- name: lectureId
in: path
description: ID of the lecture
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Lecture ended successfully.
content:
application/json:
schema:
properties:
status:
type: string
example: "OK"
message:
type: string
example: "Lecture finished successfully"
data:
type: integer
format: int64
description: "Lecture id"
example: 43872
'400':
description: Invalid or missing details
content:
application/json:
schema:
properties:
status:
type: string
example: "INVALID_DATA"
message:
type: string
example: "Invalid lecture"
security:
- access_token: []
/admin/lecture/getAllLectures:
get:
tags:
- Lectures
summary: Get all lectures
description: This endpoint will provide details of all lectures of the system.
operationId: getAllLectures
responses:
'200':
description: Lectures fetched successfully.
content:
application/json:
schema:
properties:
status:
type: string
example: "OK"
message:
type: string
example: "Lectures Fetched."
data:
type: array
items:
$ref: '#/components/schemas/LectureDTO'
'404':
description: Lectures not found.
security:
- access_token: [ ]
/admin/lecture/get-lecture/{lectureId}:
get:
tags:
- Lectures
summary: Get a lecture by ID
description: This endpoint will provide details of a lecture for a given exam ID.
operationId: getLectureById
parameters:
- name: lectureId
in: path
description: ID of the Lecture
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Lecture fetched successfully.
content:
application/json:
schema:
properties:
status:
type: string
example: "OK"
message:
type: string
example: "Lecture Fetched."
data:
$ref: '#/components/schemas/LectureDTO'
'400':
description: Invalid ID supplied or ID missing
'404':
description: Lecture ID is not found.
security:
- access_token: [ ]
/admin/lecture/getCurrentLectures:
get:
tags:
- Lectures
summary: Get currently started lectures
description: This endpoint will provide functionality for a lecturer to view his/her lectures that are currently started.
operationId: getCurrentLectures
responses:
'200':
description: Lectures Fetched.
content:
application/json:
schema:
properties:
status:
type: string
example: "OK"
message:
type: string
example: "Lectures Fetched"
data:
type: array
items:
$ref: '#/components/schemas/LectureDTO'
security:
- access_token: [ ]
/student/lecture-attendance/mark-lecture-attendance:
post:
tags:
- Lectures
summary: Mark attendance for a lecture
description: This endpoint will provide functionality for a student to mark their attendance in a lecture and display their details.
operationId: markLectureAttendance
requestBody:
description: Biometric credentials and lecture id
content:
application/json:
schema:
$ref: '#/components/schemas/MarkAttendanceRequestDTO'
required: true
responses:
'200':
description: Attendance marked successfully.
content:
application/json:
schema:
properties:
status:
type: string
example: "OK"
message:
type: string
example: "Attendance marked successfully"
data:
$ref: '#/components/schemas/StudentDTO'
'400':
description: Invalid or missing details
content:
application/json:
schema:
properties:
status:
type: string
example: "INVALID_DATA"
message:
type: string
example: "Attendance already marked"
security:
- access_token: [ ]
/admin/lecture/deleteLecture/{lectureId}:
delete:
tags:
- Lectures
summary: Delete a lecture
description: This endpoint will provide functionality for a admin to delete a lecture.
operationId: deleteLectureByID
parameters:
- name: lectureId
in: path
description: ID of the lecture
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Deleted lecture successfully.
content:
application/json:
schema:
properties:
status:
type: string
example: "LECTURE_DELETED_SUCCESSFULLY"
message:
type: string
example: "Deleted lecture successfully!"
data:
type: integer
format: int64
description: "Lecture id"
example: 43872
'400':
description: Invalid or missing details
content:
application/json:
schema:
properties:
status:
type: string
example: "LECTURE_NOT_FOUND"
message:
type: string
example: "No Lecture found corresponding to the lecture ID!"
security:
- access_token: [ ]
/admin/hall/getAllHalls:
post:
tags:
- Halls
summary: Get all of the Halls
description: This endpoint will provide a list of halls with the conducting lectures and exams of them.
operationId: getAllHalls
requestBody:
description: Start time and End time if it required otherwise empty.
content:
application/json:
schema:
$ref: '#/components/schemas/GetHallRequestDTO'
required: false
responses:
'200':
description: If there is start and end time it provide free lecture halls otherwise provides all lecture halls .
content:
application/json:
schema:
properties:
status:
type: string
example: "OK"
message:
type: string
example: "Get all lecture halls successfully!"
data:
type: array
items:
$ref: '#/components/schemas/HallsDTO'
security:
- access_token: []
/admin/hall/getHall/{hallId}:
get:
tags:
- Halls
summary: Get a hall
description: This endpoint will provide a hall with the conducting lectures and exams of it.
operationId: getHall
parameters:
- name: hallId
in: path
description: ID of the hall
required: true
schema:
type: integer
format: int64
responses:
"200":
description: Get lecture hall successfully!.
content:
application/json:
schema:
properties:
status:
type: string
example: "OK"
message:
type: string
example: "Get lecture hall successfully!"
data:
$ref: "#/components/schemas/HallsDTO"
security:
- access_token: []
#----------------------------
/admin/user/get-lecturers:
get:
tags:
- Users
summary: Get all lecturers
description: This endpoint will provide all lecturers.
operationId: getLecturers
responses:
"200":
description: Get lecture hall successfully!.
content:
application/json:
schema:
properties:
status:
type: string
example: "OK"
message:
type: string
example: "Lecturers Fetched"
data:
type: array
items:
$ref: "#/components/schemas/UserDTO"
security:
- access_token: []
components:
schemas:
AccessTokenDTO:
type: object
properties:
access_token:
type: string
example: "eeyabcdefgh"
description: Access token that can be used to access protected endpoints
expires_in:
type: integer
format: int32
example: 3600
description: Token expiry time in seconds
user_id:
type: integer
format: int32
example: 142
description: ID of the user
user_type:
type: string
example: ADMIN
description: User's type (Either 'ADMIN' or 'LECTURER')
CourseDTO:
type: object
properties:
id:
type: integer
format: int64
description: ID of course
example: 32
nullable: false
moduleCode:
type: string
example: "CS1012"
moduleName:
type: string
example: "Programming Fundamentals"
intake:
type: integer
description: Intake of course
example: 22
CreateLectureRequestDTO:
type: object
properties:
course_id:
type: integer
example: 65
hall_id:
type: integer
example: 11
lecturer_id:
type: integer
example: 37
start_time:
type: string
format: date-time
example: "2023-07-15T10:00:00"
end_time:
type: string
format: date-time
example: "2023-07-15T12:00:00"
expected_attendance:
type: integer
example: 128
CreateExamRequestDTO:
type: object
properties:
course_id:
type: integer
example: 2
hall_id:
type: integer
example: 4
invigilator_id:
type: integer
example: 19
start_time:
type: string
format: date-time
example: "2023-07-15T10:00:00"
end_time:
type: string
format: date-time
example: "2023-07-15T12:00:00"
expected_attendance:
type: integer
example: 200
ExamAttendance:
type: object
properties:
student_id:
type: string
example: ID1
index_no:
type: string
example: 190254R
nullable: true
student_name:
type: string
example: name1
nullable: true
picture:
type: string
example: "https://imgbb.com/abcdefgh"
nullable: true
is_present:
type: boolean
example: true
marked_time:
type: string
format: date-time
example: 2023-07-15T11:36:50
nullable: true
is_validated:
type: boolean
example: true
validated_time:
type: string
format: date-time
example: 2023-07-15T13:45:00
nullable: true
ExamDTO:
type: object
properties:
id:
type: integer
example: 1341
course:
$ref: '#/components/schemas/CourseDTO'
start_time:
type: string
format: date-time
example: 2023-07-15T11:00:00
end_time:
type: string
format: date-time
example: 2023-07-15T13:00:00
is_started:
type: boolean
example: true
is_ended:
type: boolean
example: false
expected_attendance:
type: integer
example: 128
attendance:
type: integer
example: 126
hall_name:
type: string
example: Seminar Room
invigilator_name:
type: string
example: James Doe
Fingerprint:
type: object
properties:
buffer:
type: object
properties:
type:
type: string
example: Buffer
data:
type: array
example: [255,216,255,224,0,16,74,70,73,70,0,1,1,0,0,1,0,1,0,0,255,254,0,32,67,114,101,97,116,101,100,32,98,121,32,73,110,169,18,75,52,142,169,110,62,240,216,163,1,190,189,43,207,126,58,248,182,120,181,11,63,15,233,215,206,187,131,61,226,138,0,41,13,20,80,2,82,209,69,0,45,20,81,64,5,20,81,64,5,20,81,64,5,20,81,64,5,20,81,64,5,20,81,64,5,20,81,64,31,255,217]
bioSubType:
type: string
example: Right Thumb
GetExamsRequestDTO:
type: object
properties:
start_time:
type: string
format: date-time
description: Beginning of time period
example: "2023-07-15T10:00:00"
required: false
end_time:
type: string
format: date-time
description: End of time period
example: "2023-07-15T12:00:00"
required: false
GetHallRequestDTO:
type: object
properties:
start_time:
type: string
format: date-time
description: Start Time
example: "2023-07-15T10:00:00"
end_time:
type: string
format: date-time
description: End Time
example: "2023-07-15T12:00:00"
HallsDTO:
type: object
properties:
id:
type: integer
format: int64
description: ID of hall
example: 6513213
nullable: false
name:
type: string
example: Exam hall 215
location:
type: string
example: Sumanadasa Building
capacity:
type: integer
description: ID of hall
example: 50
is_active:
type: boolean
example: true
LoginRequestDTO:
type: object
properties:
grant_type:
type: string
description: Grant type for authentication (should be either 'password' or 'fingerprint')
example: password
nullable: false
username:
type: string
description: Username (Email) of the user (mandatory if grant_type = 'password')
example: '[email protected]'
nullable: true
password:
type: string
description: Password of the user (mandatory if grant_type = 'password')
example: password
nullable: true