-
Notifications
You must be signed in to change notification settings - Fork 0
/
API reference.txt
801 lines (674 loc) · 14 KB
/
API reference.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
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
1)LOGIN
Endpoint: /login
Method: POST
Request:
{
Username string
Password string
}
Response:
{
Authenticated bool
Username string
UserUID string
Authorization string
Role enum
}
RoleAdmin Role = 1
RoleDoctor Role = 2
RoleResearch Role = 3
RoleNurse Role = 4
Authorization that is returned as a response is used in all of the following requests as a salt for hashing time for header authorization:
"Authorization":"<UTCtimeInRFC3339Format>|<UTCtimeInRFC3339FormatHashedWithTokenAsSalt>
2)LOGOUT
Endpoint: /logout
Metod: POST
Request:<empty>
Response:<empty>
2.5)CHANGE PASS
Endpoint: /auth/pass
Method: POST
Request:
{
OldPass string
NewPass string
}
Response:<empty>
3)ADMIN API
3.1)Person
3.1.1)Create person
Endpoint: /auth/admin/person
Method: POST
Request:
{
Name string
Surname string
JMBG string
DateOfBirth string
Address string
Email string
}
NOTE: Date format - "1989-10-21T00:00:00Z"
Response:
{
Uid string
}
3.1.2)Update person
Endpoint: /auth/admin/person/{personUID}
Method: PATCH
Request:
{
Name string
Surname string
JMBG string
DateOfBirth string
Address string
Email string
}
Response: <empty>
3.1.3) Get person
Endpoint: /auth/admin/person/{personUID}
Method: GET
Request:<empty>
Response:
{
Name string
Surname string
JMBG string
DateOfBirth string
Address string
Email string
}
3.1.4)Get all persons
Endpoint: /auth/admin/person
Method: GET
Request:<empty>
Response:
{
Persons: [
{
Uid string
Name string
Surname string
JMBG string
},
{
Uid string
Name string
Surname string
JMBG string
}
.....
]
}
3.1.5) Delete person
Endpoint: /auth/admin/person/{personUID}
Method: DELETE
Request:<empty>
Response:<empty>
3.2)Employee
3.2.1)Create employee
Endpoint: /auth/admin/employee
Method: POST
Request:
{
Name string
Surname string
JMBG string
DateOfBirth string
Address string
Email string
PersonUid string
WorkDocumentId string
RoleId int
}
NOTE:You should either send PersonUid of existing person, or data for creating new person for employee.
Response:
{
Uid string
}
3.2.2) Update employee
Endpoint: /auth/admin/employee/{employeeUid}
Method: PATCH
Request:
{
Name string
Surname string
JMBG string
DateOfBirth string
Address string
Email string
WorkDocumentId string
RoleId int
}
Response:<empty>
3.2.3) Get employee
Endpoint: /auth/admin/employee/{employeeUid}
Method: GET
Request:<empty>
Response:
{
Uid string
Name string
Surname string
JMBG string
DateOfBirth string
Address string
Email string
WorkDocumentId string
RoleId int
}
3.2.4) Get employees
Endpoint: /auth/admin/employee
Method: GET
Request: <empty>
Response:
{
Employees:[
{
Uid string
Name string
Surname string
WorkDocumentId string
RoleId int
},
{
Uid string
Name string
Surname string
WorkDocumentId string
RoleId int
}
........
]
}
3.2.4) Delete employee
Endpoint: /auth/admin/employee/{employeeUid}
Method: DELETE
Request: <empty>
Response: <empty>
3.3)User
3.3.1)Create user
Endpoint: /auth/admin/user
Method: POST
Request:
{
Name string
Surname string
JMBG string
DateOfBirth string
Address string
Email string
EmployeeUid string
WorkDocumentId string
RoleId int
Username string
Password string
}
NOTE:You should either send EmployeeUid of existing employee, or data for creating new employee.
Response:
{
Uid string
}
3.3.2) Update user
Endpoint: /auth/admin/user/{userUID}
Method: PATCH
Request:
{
Name string
Surname string
JMBG string
DateOfBirth string
Address string
Email string
WorkDocumentId string
RoleId int
Username string
Password string
}
Response: <empty>
3.3.3) Get user
Endpoint: /auth/admin/user/{userUID}
Method: GET
Request:<empty>
Response:
{
Uid string
Name string
Surname string
JMBG string
DateOfBirth string
Address string
Email string
WorkDocumentId string
RoleId int
Username string
}
3.3.4) Get users
Endpoint: /auth/admin/user
Method: GET
Request:<empty>
Response:
{
Users:[
{
Uid string
Name string
Surname string
WorkDocumentId string
RoleId int
Username string
},
{
Uid string
Name string
Surname string
WorkDocumentId string
RoleId int
Username string
}
........
]
}
3.3.4) Delete user
Endpoint: /auth/admin/user/{userUID}
Method: DELETE
Request:<empty>
Response:<empty>
4)Nurse API
4.1)Person
4.1.1)Create person
Endpoint: /auth/nurse/person
Method: POST
Request:
{
Name string
Surname string
JMBG string
DateOfBirth string
Address string
Email string
}
NOTE: Date format - "1989-10-21T00:00:00Z"
Response:
{
Uid string
}
4.1.2)Update person
Endpoint: /auth/nurse/person/{personUID}
Method: PATCH
Request:
{
Name string
Surname string
JMBG string
DateOfBirth string
Address string
Email string
}
Response: <empty>
4.1.3) Get person
Endpoint: /auth/nurse/person/{personUID}
Method: GET
Request:<empty>
Response:
{
Name string
Surname string
JMBG string
DateOfBirth string
Address string
Email string
}
4.1.4)Get all persons
Endpoint: /auth/nurse/person
Method: GET
Request:<empty>
Response:
{
Persons: [
{
Uid string
Name string
Surname string
JMBG string
},
{
Uid string
Name string
Surname string
JMBG string
}
.....
]
}
4.2)Patient
4.2.1)Create patient
Endpoint: /auth/nurse/patient
Method: POST
Request:
{
Name string
Surname string
JMBG string
DateOfBirth string
Address string
Email string
PersonUid string
MedicalRecordId string
HealthCardId string
HealthCardValidUntil string
}
Date format - "1989-10-21T00:00:00Z"
NOTE:You should either send PersonUid of existing person, or data for creating new person for patient.
Response:
{
Uid string
}
4.2.2) Update patient
Endpoint: /auth/nurse/patient/{patientUid}
Method: PATCH
Request:
{
Name string
Surname string
JMBG string
DateOfBirth string
Address string
Email string
MedicalRecordId string
HealthCardId string
HealthCardValidUntil string
}
Response: <empty>
4.2.3) Get patient
Endpoint: /auth/nurse/patient/{patientUid}
Method: GET
Request:<empty>
Response:
{
Uid string
Name string
Surname string
JMBG string
DateOfBirth string
Address string
Email string
MedicalRecordId string
HealthCardId string
HealthCardValidUntil string
}
4.2.4)Get patients
Endpoint: /auth/nurse/patient
Method: GET
Request: <empty>
Response:
{
Patients:[
{
Uid string
Name string
Surname string
MedicalRecordId string
HealthCardId string
HealthCardValidUntil string
},
{
Uid string
Name string
Surname string
MedicalRecordId string
HealthCardId string
HealthCardValidUntil string
}
...........
]
}
4.2.4) Delete patient
Endpoint: /auth/nurse/patient/{patientUid}
Method: DELETE
Request: <empty>
Response: <empty>
4.3)Examination
4.3.1)Create examination
Endpoint: /auth/nurse/examination
Method: POST
Request:
{
DoctorUid string,
PatientUid string,
ExaminationDate string
}
Response:
{
Uid string
}
4.3.2) Get examinations
Endpoint: /auth/nurse/examination
Method: GET
Request: <empty>
Response:
{
Examination: [
{
Uid string,
DoctorUid string,
DoctorFullName string,
PatientUid string,
PatientFullName string,
ExaminationDate string
},
{
Uid string,
DoctorUid string,
DoctorFullName string,
PatientUid string,
PatientFullName string,
ExaminationDate string
}
...........
]
}
4.3.3) Delete examinationn
Endpoint: /auth/nurse/examination/{examinationUID}
Method: DELETE
Request: <empty>
Response: <empty>
4.4)Doctors
4.4.1)Get doctors
Endpoint: /auth/nurse/doctor
Method: GET
Request: <empty>
Response:
{
Employees:[
{
Uid string
Name string
Surname string
WorkDocumentId string
},
{
Uid string
Name string
Surname string
WorkDocumentId string
}
]
}
5)Doctor API
5.1)Test
5.1.1)Create test
Test is created by uploading excel file(look at the example.xlsx).
Upload is done by doing POST with form on /auth/doctor/test with file in form-data.
In form the file is stored with name fileUpload.
Additional attributes are "name" with test name and specialty that is speialization enum.
File format:
Control words are in first column(names are customizable by changing server.toml)
Start - begining of the question structure
Question - in the cell to the right of it is the text of the question
Type- in a cell to the right is the type of the answer options (text, radio, checkbox, number)
Answers - valid only for radio and checkbox, in the cells to the right are the potential answers that are shown to the user
End - ending of the question structure
5.1.2)Get tests
Endpoint: /auth/doctor/test
Method: GET
Request: <empty>
Response
{
Tests:
[
{
"Name": string,,
"UID": string,
"Specialty": int
},
{
"Name": string,,
"UID": string,
"Specialty": int
}
........
]
}
5.1.3)Get tests
Endpoint: /auth/doctor/test/{testUID}
Method: GET
Request:<empty>
Response
{
"Uid": string,
"Specialty": int,
"Name": <name>
"Questions":
[
{
"Type": string,
"Answers": []string,
"Question": string
},
.......
]
}
5.1.2)Delete test
Endpoint: /auth/doctor/test/{testUID}
Method: DELETE
Request:<empty>
Response:<empty
5.2)Filled test
5.2.1)Create filled test
Endpoint: /auth/doctor/filled
Method: POST
Request:
{
"ExaminationUid": string
"TestUid":string
"Answers":json
}
Response: <empty>
5.2.2)Get filled tests
Endpoint: /auth/doctor/filled
Method: GET
Request:<empty>
Response
{
"FilledTests":
[
{
"Uid": string
"TestName": string
"ExaminationDate": time
"PatientName": string
"PatientUid": string
},
{
"Uid": string
"TestName": string
"ExaminationDate": time
"PatientName": string
"PatientUid": string
}
.....
]
}
5.2.3)Get filled test
Endpoint: /auth/doctor/filled/{filledTestUID}
Method: GET
Request:<empty>
Response
{
"TestUid": string,
“TestName”: string,
"ExaminationUID": string,
"Answers": json
}
5.2.4)Delete filled test
Endpoint: /auth/doctor/filled/{filledTestUID}
Method: DELETE
Request:<empty>
Response:<empty>
5.3) Examinations
5.3.1) Read examinations
Endpoint: /auth/doctor/examination
Method: GET
Request: <empty>
Response:
{
Examination: [
{
Uid string,
DoctorUid string,
DoctorFullName string,
PatientUid string,
PatientFullName string,
ExaminationDate string
},
{
Uid string,
DoctorUid string,
DoctorFullName string,
PatientUid string,
PatientFullName string,
ExaminationDate string
}
.........
]
}
6)Research API
6.1)Filled tests
6.1.1)Get filled tests
Endpoint: /auth/research/filled
Method: GET
Request:<empty>
Response
{
"FilledTests":
[
{
"Uid": string
"TestName": string
"ExaminationDate": time
"PatientName": string
"PatientUid": string
},
{
"Uid": string
"TestName": string
"ExaminationDate": time
"PatientName": string
"PatientUid": string
}
.....
]
}
6.1.2)Get filled test
Endpoint: /auth/research/filled/{filledTestUID}
Method: GET
Request:<empty>
Response
{
"TestUid": string,
“TestName”: string,
"ExaminationUID": string,
"Answers": json
}