-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswagger.json
1456 lines (1456 loc) · 51.4 KB
/
swagger.json
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
{
"swagger": "2.0",
"info": {
"title": "Fakad Infotech Centre Management API",
"description": "API documentation for the Fakad Management API. This API is designed to help you manage student applications, contact messages, and user accounts efficiently. Whether you need to create, retrieve, update, or delete records, this API has got you covered. With a user-friendly interface and comprehensive functionality, you can seamlessly integrate these management tasks into your applications.\n\n**Key Features:**\n\n- **Create Student Applications:** Use the POST endpoint to add new student applications to your database, providing details like name, contact information, guardian details, and choice of training programme.\n\n- **Retrieve Student Applications:** The GET endpoint allows you to fetch a list of all student applications or retrieve a specific application by its unique ID.\n\n- **Update Student Applications:** Easily update student application information using the PUT endpoint. Send the updated details in JSON format to modify existing applications.\n\n- **Delete Student Applications:** Remove student applications from your database using the DELETE endpoint. Specify the application's ID to delete a specific entry.\n\n- **Create Contact Messages:** Use the POST endpoint to add new contact messages to your database, providing details like name, email, phone, subject, and message.\n\n- **Retrieve Contact Messages:** The GET endpoint allows you to fetch a list of all contact messages or retrieve a specific message by its unique ID.\n\n- **Update Contact Messages:** Easily update contact message information using the PUT endpoint. Send the updated details in JSON format to modify existing messages.\n\n- **Delete Contact Messages:** Remove contact messages from your database using the DELETE endpoint. Specify the message's ID to delete a specific entry.\n\n- **Create User Accounts:** Use the POST endpoint to add new user accounts to your database, providing details like full name, username, password, email, phone number, date of birth, and gender.\n\n- **Retrieve User Accounts:** The GET endpoint allows you to fetch a list of all user accounts or retrieve a specific account by its unique ID.\n\n- **Update User Accounts:** Easily update user account information using the PUT endpoint. Send the updated details in JSON format to modify existing accounts.\n\n- **Delete User Accounts:** Remove user accounts from your database using the DELETE endpoint. Specify the account's ID to delete a specific entry.\n\n**Sample Requests and Responses:** We've provided sample JSON requests and responses for each endpoint to help you understand how to interact with the API effectively.\n\n**Error Handling:** The API includes error responses and status codes to guide you in case of any issues.\n\n**API Documentation:** Explore the detailed API documentation below to learn how to use each endpoint, the expected request structures, and response formats.\n\nStart managing your student applications, contact messages, and user accounts effortlessly with the Fakad Infotech Centre Management API. Integrate it into your applications to streamline these management tasks and enhance user experiences.\n\n\n# DEVELOPER'S GUIDE/INSTRUCTIONS ON HOW TO PERFORM THE CRUD\n-----------------------------------------------------------------\nFor local testing, replace the base URL \"https://fakad-student-application.onrender.com/application-form\" with http://localhost:8080/application-form.\n\nFor example, the endpoint \"https://fakad-student-application.onrender.com/application-form\" should be accessed as \"http://localhost:8080/application-form\" when testing locally. Everything else in the API request remains the same.\n\n-----------------------------------------------------------------\n\n## Application form\n### // PRODUCTION\n\n#### create fakads\ncurl -X POST https://fakad-student-application.onrender.com/application-form/\n-H \"Content-Type: application/json\" -d '{\n \"firstName\": \"Hope\",\n \"middleName\": \"A\",\n \"lastName\": \"Simon\",\n \"gender\": \"Female\",\n \"dateOfBirth\": \"1990-05-15\",\n \"maritalStatus\": \"Single\",\n \"phoneNumber\": \"+1234567890\",\n \"email\": \"[email protected]\",\n \"contactAddress\": \"123 Tech Street\",\n \"occupation\": \"Software Engineer\",\n \"placeOfBirth\": \"Tech City\",\n \"stateOfOrigin\": \"Tech State\",\n \"localGovtArea\": \"Tech Local Govt\",\n \"homeTown\": \"Tech Town\",\n \"villageAddress\": \"Tech Village\",\n \"previousTraining\": \"Yes\",\n \"previousTrainingDetails\": {\n \"trainingPlaceName\": \"Tech Training Center\",\n \"trainingAddress\": \"456 Training Avenue\",\n \"trainingDuration\": \"6 months\"\n },\n \"choiceOfTrainingProgramme\": \"Certificate\",\n \"passportPhotograph\": \"base64ImageString\",\n \"guardian\": {\n \"firstName\": \"GuardianFirstName\",\n \"middleName\": \"GuardianMiddleName\",\n \"lastName\": \"GuardianLastName\",\n \"gender\": \"Male\",\n \"maritalStatus\": \"Married\",\n \"phoneNumber\": \"+9876543210\",\n \"email\": \"[email protected]\",\n \"contactAddress\": \"789 Guardian Street\",\n \"occupation\": \"Guardian Occupation\",\n \"placeOfBirth\": \"Guardian City\",\n \"stateOfOrigin\": \"Guardian State\",\n \"localGovtArea\": \"Guardian Local Govt\",\n \"homeTown\": \"Guardian Town\",\n \"villageAddress\": \"Guardian Village\",\n \"identificationType\": \"National ID\",\n \"identificationUpload\": \"base64ImageString\",\n \"passportPhotograph\": \"guardianBase64ImageString\"\n },\n \"nextOfKin\": {\n \"firstName\": \"NextOfKinFirstName\",\n \"middleName\": \"NextOfKinMiddleName\",\n \"lastName\": \"NextOfKinLastName\",\n \"gender\": \"Female\",\n \"maritalStatus\": \"Single\",\n \"relationship\": \"Mother\",\n \"phoneNumber\": \"+9876543210\",\n \"email\": \"[email protected]\",\n \"contactAddress\": \"789 NextOfKin Street\",\n \"occupation\": \"NextOfKin Occupation\",\n \"placeOfBirth\": \"NextOfKin City\",\n \"stateOfOrigin\": \"NextOfKin State\",\n \"localGovtArea\": \"NextOfKin Local Govt\",\n \"homeTown\": \"NextOfKin Town\",\n \"villageAddress\": \"NextOfKin Village\"\n }\n}'\n\n### Get all fakads\nGET https://fakad-student-application.onrender.com/application-form/\n\n\n### Get a fakad by ID\nGET https://fakad-student-application.onrender.com/application-form/66a4d0a8b662e5bd9f890aa8\n// Replace :id with the actual ID of the fakad\n\n\n### Update a fakad\ncurl -X PUT https://fakad-student-application.onrender.com/application-form/66a4d0a8b662e5bd9f890aa8 -H \"Content-Type: application/json\" -d '{\n \"firstName\": \"John\",\n \"middleName\": \"B\",\n \"lastName\": \"Doe\",\n \"gender\": \"Male\",\n \"dateOfBirth\": \"1995-08-20\",\n \"maritalStatus\": \"Married\",\n \"phoneNumber\": \"+9876543210\",\n \"email\": \"[email protected]\",\n \"contactAddress\": \"456 Data Avenue\",\n \"occupation\": \"Data Scientist\",\n \"placeOfBirth\": \"Data City\",\n \"stateOfOrigin\": \"Data State\",\n \"localGovtArea\": \"Data Local Govt\",\n \"homeTown\": \"Data Town\",\n \"villageAddress\": \"Data Village\",\n \"previousTraining\": \"No\",\n \"choiceOfTrainingProgramme\": \"Diploma\",\n \"passportPhotograph\": \"newBase64ImageString\",\n \"guardian\": {\n \"firstName\": \"UpdatedGuardianFirstName\",\n \"middleName\": \"\",\n \"lastName\": \"UpdatedGuardianLastName\",\n \"gender\": \"Female\",\n \"maritalStatus\": \"Divorced\",\n \"phoneNumber\": \"+9876543210\",\n \"email\": \"[email protected]\",\n \"contactAddress\": \"789 Updated Guardian Street\",\n \"occupation\": \"Updated Guardian Occupation\",\n \"placeOfBirth\": \"Updated Guardian City\",\n \"stateOfOrigin\": \"Updated Guardian State\",\n \"localGovtArea\": \"Updated Guardian Local Govt\",\n \"homeTown\": \"Updated Guardian Town\",\n \"villageAddress\": \"Updated Guardian Village\",\n \"identificationType\": \"International Passport\",\n \"identificationUpload\": \"updatedBase64ImageString\",\n \"passportPhotograph\": \"updatedGuardianBase64ImageString\"\n },\n \"nextOfKin\": {\n \"firstName\": \"UpdatedNextOfKinFirstName\",\n \"middleName\": \"\",\n \"lastName\": \"UpdatedNextOfKinLastName\",\n \"gender\": \"Male\",\n \"maritalStatus\": \"Married\",\n \"relationship\": \"Father\",\n \"phoneNumber\": \"+9876543210\",\n \"email\": \"[email protected]\",\n \"contactAddress\": \"789 Updated NextOfKin Street\",\n \"occupation\": \"Updated NextOfKin Occupation\",\n \"placeOfBirth\": \"Updated NextOfKin City\",\n \"stateOfOrigin\": \"Updated NextOfKin State\",\n \"localGovtArea\": \"Updated NextOfKin Local Govt\",\n \"homeTown\": \"Updated NextOfKin Town\",\n \"villageAddress\": \"Updated NextOfKin Village\"\n }\n}'\n\n\n### Delete a fakad by ID\nDELETE https://fakad-student-application.onrender.com/application-form/66b355dc20e5e94c404ff3e9\n\n\n-----------------------------------------------------------------\n\n\n### Contact us \n## // PRODUCTION\n\n### Create a contact message\ncurl -X POST https://fakad-student-application.onrender.com/application-form/contact-us/ -H \"Content-Type: application/json\" -d '{\n \"name\": \"John Doe\",\n \"email\": \"[email protected]\",\n \"phone\": \"+1234567890\",\n \"subject\": \"Inquiry about services\",\n \"message\": \"I would like to know more about your training programs.\"\n}'\n\n### Get all contact messages\nGET https://fakad-student-application.onrender.com/application-form/contact-us/\n\n### Get a contact message by ID\nGET https://fakad-student-application.onrender.com/application-form/contact-us/668927861ce7bfba1f64ab5e\n// Replace :id with the actual ID of the contact message\n\n### Update a contact message\ncurl -X PUT https://fakad-student-application.onrender.com/application-form/contact-us/668927861ce7bfba1f64ab5e -H \"Content-Type: application/json\" -d '{\n \"name\": \"Jane Doe\",\n \"email\": \"[email protected]\",\n \"phone\": \"+0987654321\",\n \"subject\": \"Updated inquiry\",\n \"message\": \"I have more questions about your training programs.\"\n}'\n\n\n### Delete a contact message by ID\nDELETE https://fakad-student-application.onrender.com/application-form/contact-us/1234567890abcdef12345678\n\n\n-----------------------------------------------------------------\n### Create Account\n## PRODUCTION\n\n### Create an account message\ncurl -X POST https://fakad-student-application.onrender.com/application-form/create-account/ -H \"Content-Type: application/json\" -H \"Authorization: Bearer 7830b3752ea8ea01538d3123c7c512fd7fa26dbeb49c5b5030d30926f4f6e20d\" -d '{\n \"fullName\": \"Jane John\",\n \"username\": \"john\",\n \"password\": \"newpassword123\",\n \"confirmPassword\": \"newpassword123\",\n \"email\": \"[email protected]\",\n \"phone\": \"+0987654321\",\n \"dob\": \"1992-02-02\",\n \"gender\": \"Female\",\n \"terms\": true,\n \"privacy\": true\n}'\n\n\n### Login \ncurl -X POST https://fakad-student-application.onrender.com/application-form/create-account/login -H \"Content-Type: application/json\" -d '{\n \"username\": \"dagwan\",\n \"password\": \"dagwanpan0810\"\n}'\n\n### Forgot Password\ncurl -X POST https://fakad-student-application.onrender.com/application-form/create-account/forgot-password -H \"Content-Type: application/json\" -d '{\n \"email\": \"[email protected]\"\n}'\n\n### Reset Password\ncurl -X POST https://fakad-student-application.onrender.com/application-form/create-account/reset-password/e85683ee38bf459b089ff4b028bc7836e3ff729853896ab7c351c5383c7bbb60 -H \"Content-Type: application/json\" -d '{\n \"password\": \"dagwanpan0810\",\n \"confirmPassword\": \"dagwanpan0810\"\n}'\n\n### Get all user accounts\ncurl -X GET https://fakad-student-application.onrender.com/application-form/create-account/ -H \"Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhY2NvdW50SWQiOiI2NjlmZTY0MDA2YWFmNDAxOTExNDJiMTQiLCJ1c2VybmFtZSI6ImRhZ3dhbiIsImlhdCI6MTcyMTc1NTIwMCwiZXhwIjoxNzIxNzU4ODAwfQ.7lhXzvfOq5gIjghE4lgq0IVjvb0rIADCXOXEgxvXA7A\"\n\n### Get a user account by ID\ncurl -X GET https://fakad-student-application.onrender.com/application-form/create-account/669fe64006aaf40191142b14 -H \"Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhY2NvdW50SWQiOiI2NjlmZTY0MDA2YWFmNDAxOTExNDJiMTQiLCJ1c2VybmFtZSI6ImRhZ3dhbiIsImlhdCI6MTcyMTc1NTIwMCwiZXhwIjoxNzIxNzU4ODAwfQ.7lhXzvfOq5gIjghE4lgq0IVjvb0rIADCXOXEgxvXA7A\"\n### Replace :id with the actual ID of the user account\n\n### Update a user account\ncurl -X PUT https://fakad-student-application.onrender.com/application-form/create-account/669fe64006aaf40191142b14 -H \"Content-Type: application/json\" -H \"Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhY2NvdW50SWQiOiI2NjlmZTY0MDA2YWFmNDAxOTExNDJiMTQiLCJ1c2VybmFtZSI6ImRhZ3dhbiIsImlhdCI6MTcyMTc1NTIwMCwiZXhwIjoxNzIxNzU4ODAwfQ.7lhXzvfOq5gIjghE4lgq0IVjvb0rIADCXOXEgxvXA7A\" -d '{\n \"fullName\": \"Jane Doe\",\n \"username\": \"janedoe\",\n \"password\": \"newpassword123\",\n \"confirmPassword\": \"newpassword123\",\n \"email\": \"[email protected]\",\n \"phone\": \"+0987654321\",\n \"dob\": \"1992-02-02\",\n \"gender\": \"Female\",\n \"terms\": true,\n \"privacy\": true\n}'\n### Replace :id with the actual ID of the user account\n\n### Delete a user account by ID\ncurl -X DELETE https://fakad-student-application.onrender.com/application-form/create-account/669fe64006aaf40191142b14 -H \"Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhY2NvdW50SWQiOiI2NjlmZTY0MDA2YWFmNDAxOTExNDJiMTQiLCJ1c2VybmFtZSI6ImRhZ3dhbiIsImlhdCI6MTcyMTc1NTIwMCwiZXhwIjoxNzIxNzU4ODAwfQ.7lhXzvfOq5gIjghE4lgq0IVjvb0rIADCXOXEgxvXA7A\"\n### Replace :id with the actual ID of the user account",
"version": "1.0.0"
},
"host": "localhost:8080/application-form/api-docs",
"basePath": "/",
"schemes": [
"http"
],
"securityDefinitions": {
"Bearer": {
"type": "apiKey",
"name": "Authorization",
"in": "header",
"description": "Enter your bearer token in the format **Bearer <token>**"
}
},
"paths": {
"/application-form/": {
"post": {
"description": "",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"firstName": {
"example": "any"
},
"middleName": {
"example": "any"
},
"lastName": {
"example": "any"
},
"gender": {
"example": "any"
},
"dateOfBirth": {
"example": "any"
},
"maritalStatus": {
"example": "any"
},
"phoneNumber": {
"example": "any"
},
"email": {
"example": "any"
},
"contactAddress": {
"example": "any"
},
"occupation": {
"example": "any"
},
"placeOfBirth": {
"example": "any"
},
"stateOfOrigin": {
"example": "any"
},
"localGovtArea": {
"example": "any"
},
"homeTown": {
"example": "any"
},
"villageAddress": {
"example": "any"
},
"previousTraining": {
"example": "any"
},
"previousTrainingDetails": {
"example": "any"
},
"choiceOfTrainingProgramme": {
"example": "any"
},
"guardian": {
"example": "any"
},
"nextOfKin": {
"example": "any"
}
}
}
}
],
"responses": {
"201": {
"description": "Created"
},
"400": {
"description": "Bad Request"
},
"500": {
"description": "Internal Server Error"
}
}
},
"get": {
"description": "",
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/application-form/{id}": {
"get": {
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
}
},
"put": {
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"firstName": {
"example": "any"
},
"middleName": {
"example": "any"
},
"lastName": {
"example": "any"
},
"gender": {
"example": "any"
},
"dateOfBirth": {
"example": "any"
},
"maritalStatus": {
"example": "any"
},
"phoneNumber": {
"example": "any"
},
"email": {
"example": "any"
},
"contactAddress": {
"example": "any"
},
"occupation": {
"example": "any"
},
"placeOfBirth": {
"example": "any"
},
"stateOfOrigin": {
"example": "any"
},
"localGovtArea": {
"example": "any"
},
"homeTown": {
"example": "any"
},
"villageAddress": {
"example": "any"
},
"previousTraining": {
"example": "any"
},
"previousTrainingDetails": {
"example": "any"
},
"choiceOfTrainingProgramme": {
"example": "any"
},
"passportPhotograph": {
"example": "any"
},
"guardian": {
"example": "any"
},
"nextOfKin": {
"example": "any"
}
}
}
}
],
"responses": {
"201": {
"description": "Created"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
}
},
"delete": {
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"201": {
"description": "Created"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/contact-us/": {
"post": {
"description": "",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"name": {
"example": "any"
},
"email": {
"example": "any"
},
"phone": {
"example": "any"
},
"subject": {
"example": "any"
},
"message": {
"example": "any"
}
}
}
}
],
"responses": {
"201": {
"description": "Created"
},
"400": {
"description": "Bad Request"
},
"500": {
"description": "Internal Server Error"
}
}
},
"get": {
"description": "",
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/contact-us/{id}": {
"get": {
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
}
},
"put": {
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"name": {
"example": "any"
},
"email": {
"example": "any"
},
"phone": {
"example": "any"
},
"subject": {
"example": "any"
},
"message": {
"example": "any"
}
}
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
}
},
"delete": {
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/create-account/": {
"post": {
"description": "",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"fullName": {
"example": "any"
},
"username": {
"example": "any"
},
"password": {
"example": "any"
},
"confirmPassword": {
"example": "any"
},
"email": {
"example": "any"
},
"phone": {
"example": "any"
},
"dob": {
"example": "any"
},
"gender": {
"example": "any"
},
"terms": {
"example": "any"
},
"privacy": {
"example": "any"
}
}
}
}
],
"responses": {
"201": {
"description": "Created"
},
"400": {
"description": "Bad Request"
},
"500": {
"description": "Internal Server Error"
}
}
},
"get": {
"description": "",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Authorization",
"in": "header",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "Unauthorized"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/create-account/login": {
"post": {
"description": "",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"username": {
"example": "any"
},
"password": {
"example": "any"
}
}
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/create-account/forgot-password": {
"post": {
"description": "",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"email": {
"example": "any"
}
}
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/create-account/reset-password/{token}": {
"post": {
"description": "",
"parameters": [
{
"name": "token",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"password": {
"example": "any"
},
"confirmPassword": {
"example": "any"
}
}
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/create-account/{id}": {
"get": {
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "Authorization",
"in": "header",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
}
},
"put": {
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "Authorization",
"in": "header",
"type": "string"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"fullName": {
"example": "any"
},
"username": {
"example": "any"
},
"password": {
"example": "any"
},
"confirmPassword": {
"example": "any"
},
"email": {
"example": "any"
},
"phone": {
"example": "any"
},
"dob": {
"example": "any"
},
"gender": {
"example": "any"
},
"terms": {
"example": "any"
},
"privacy": {
"example": "any"
}
}
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
}
},
"delete": {
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "Authorization",
"in": "header",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
}
}
}
},
"definitions": {
"StudentApplication": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "object"
},
"properties": {
"type": "object",
"properties": {
"firstName": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "string"
}
}
},
"middleName": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "string"
}
}
},
"lastName": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "string"
}
}
},
"gender": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "string"
}
}
},
"dateOfBirth": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "string"
},
"format": {
"type": "string",
"example": "date"
}
}
},
"maritalStatus": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "string"
}
}
},
"phoneNumber": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "string"
}
}
},
"email": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "string"
}
}
},
"contactAddress": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "string"
}
}
},
"occupation": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "string"
}
}
},
"placeOfBirth": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "string"
}
}
},
"stateOfOrigin": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "string"
}
}
},
"localGovtArea": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "string"
}
}
},
"homeTown": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "string"
}
}
},
"villageAddress": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "string"
}
}
},
"previousTraining": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "string"
}
}
},
"previousTrainingDetails": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "object"
},
"properties": {
"type": "object",
"properties": {
"trainingPlaceName": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "string"
}
}
},
"trainingAddress": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "string"
}
}
},
"trainingDuration": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "string"
}
}
}
}
}
}
},
"choiceOfTrainingProgramme": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "string"
}
}
},
"passportPhotograph": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "string"
}
}
},
"guardian": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "object"
},
"properties": {
"type": "object",
"properties": {
"firstName": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "string"
}
}
},
"middleName": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "string"
}
}
},
"lastName": {
"type": "object",
"properties": {
"type": {
"type": "string",