-
Notifications
You must be signed in to change notification settings - Fork 7
/
Copy pathGordon360.xml
2836 lines (2820 loc) · 165 KB
/
Gordon360.xml
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
<?xml version="1.0"?>
<doc>
<assembly>
<name>Gordon360</name>
</assembly>
<members>
<member name="M:Gordon360.Authorization.AuthUtils.GetUsername(System.Security.Claims.ClaimsPrincipal)">
<summary>
Get the username of the authenticated user
</summary>
<param name="User">The ClaimsPrincipal representing the user's authentication claims</param>
<returns>Username of the authenticated user</returns>
</member>
<member name="M:Gordon360.Controllers.Api.AcademicCheckInController.PutEmergencyContactAsync(Gordon360.Models.ViewModels.EmergencyContactViewModel)">
<summary>Set emergency contacts for student</summary>
<param name="data"> The contact data to be stored </param>
<returns> The data stored </returns>
</member>
<member name="M:Gordon360.Controllers.Api.AcademicCheckInController.PutCellPhoneAsync(Gordon360.Models.ViewModels.MobilePhoneUpdateViewModel)">
<summary> Sets the students cell phone number</summary>
<param name="data"> The phone number object to be added to the database </param>
</member>
<member name="M:Gordon360.Controllers.Api.AcademicCheckInController.PutDemographicAsync(Gordon360.Models.ViewModels.AcademicCheckInViewModel)">
<summary>Sets the students race and ethinicity</summary>
<param name="data"> The object containing the race numbers of the users </param>
<returns> The data stored </returns>
</member>
<member name="M:Gordon360.Controllers.Api.AcademicCheckInController.GetHoldsAsync">
<summary> Gets and returns the user's holds </summary>
<returns> The user's stored holds </returns>
</member>
<member name="M:Gordon360.Controllers.Api.AcademicCheckInController.SetStatusAsync">
<summary> Sets the user as having completed Academic Checkin </summary>
<returns> The HTTP status indicating whether the request was completed or not</returns>
</member>
<member name="M:Gordon360.Controllers.Api.AcademicCheckInController.GetStatusAsync">
<summary> Gets whether the user has checked in or not. True if they have checked in, false if they have not checked in </summary>
<returns> The HTTP status indicating whether the request was completed and returns the check in status of the student </returns>
</member>
<member name="M:Gordon360.Controllers.AccountsController.SearchAsync(System.String)">
<summary>
Return a list of accounts matching some or all of <c>searchString</c>.
</summary>
<param name="searchString">The input to search for</param>
<returns>All accounts meeting some or all of the parameter, sorted according to how well the account matched the search.</returns>
</member>
<member name="M:Gordon360.Controllers.AccountsController.SearchWithSpaceAsync(System.String,System.String)">
<summary>
Return a list of accounts matching some or all of the search parameter.
</summary>
<param name="firstName">The firstname portion of the search</param>
<param name="lastName">The lastname portion of the search</param>
<returns> All accounts matching some or all of both the firstname and lastname parameters, sorted by how well the account matched the search.</returns>
</member>
<member name="M:Gordon360.Controllers.AccountsController.AdvancedPeopleSearchAsync(System.Collections.Generic.List{System.String},System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.String,System.String,System.String,System.String)">
<summary>
Return a list of accounts matching some or all of the search parameters
We are searching through all the info of a user, then narrowing it down to get only what we want
</summary>
<param name="accountTypes"> Which account types to search. Accepted values: "student", "alumni", "facstaff" </param>
<param name="firstname"> The first name to search for </param>
<param name="lastname"> The last name to search for </param>
<param name="major"></param>
<param name="minor"></param>
<param name="hall"></param>
<param name="classType"></param>
<param name="preferredClassYear"></param>
<param name="initialYear"></param>
<param name="finalYear"></param>
<param name="homeCity"></param>
<param name="state"></param>
<param name="country"></param>
<param name="department"></param>
<param name="building"></param>
<param name="involvement"></param>
<returns> All accounts meeting some or all of the parameter</returns>
</member>
<member name="M:Gordon360.Controllers.ActivitiesController.GetActivitiesForSessionAsync(System.String)">
<summary>Gets the activities taking place during a given session</summary>
<param name="id">The session identifier</param>
<returns>A list of all activities that are active during the given session determined by the id parameter</returns>
<remarks>Queries the database to find which activities are active during the session desired</remarks>
</member>
<member name="M:Gordon360.Controllers.ActivitiesController.GetActivityTypesForSessionAsync(System.String)">
<summary>Gets the different types of activities taking place during a given session</summary>
<param name="id">The session identifier</param>
<returns>A list of all the different types of activities that are active during the given session determined by the id parameter</returns>
<remarks>Queries the database to find the distinct activities type of activities that are active during the session desired</remarks>
</member>
<member name="M:Gordon360.Controllers.ActivitiesController.GetActivityStatus(System.String,System.String)">
<summary>
Get the status (open or closed) of an activity for a given session
</summary>
<param name="sessionCode">The session code that we want to check the status for</param>
<param name="id"></param>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.ActivitiesController.GetOpenActivities">
<summary>
Get all activities that have not yet been closed out for the current session
</summary>
<returns>Enumerable of ActivityInfo for each open activity in the current session</returns>
</member>
<member name="M:Gordon360.Controllers.ActivitiesController.GetClosedActivities">
<summary>
Get all the activities that are already closed out for the current session
</summary>
<returns>Enumerable of ActivityInfo for each closed activity in the current session</returns>
</member>
<member name="M:Gordon360.Controllers.ActivitiesController.Put(System.String,Gordon360.Models.ViewModels.InvolvementUpdateViewModel)">
<summary>
</summary>
<param name="involvement_code">The code of the activity to update</param>
<param name="involvement">The updated involvement details</param>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.ActivitiesController.PostImageAsync(System.String,Microsoft.AspNetCore.Http.IFormFile)">
<summary>
Set an image for the activity
</summary>
<param name="involvement_code">The activity code</param>
<param name="image">The image file</param>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.ActivitiesController.ResetImage(System.String)">
<summary>
Reset the activity Image
</summary>
<param name="involvement_code">The activity code</param>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.ActivitiesController.TogglePrivacy(System.String,System.Boolean)">
<summary>Update an existing activity to be private or not</summary>
<param name="involvement_code">The code of the involvement</param>
<param name = "p">the boolean value</param>
<remarks>Calls the server to make a call and update the database with the changed information</remarks>
</member>
<member name="M:Gordon360.Controllers.AddressesController.GetAllStates">
<summary>
Pulls all states available from Jenzabar States Table
</summary>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.AddressesController.GetAllCountries">
<summary>
Pulls all Countries available from Jenzabar Countries Table
</summary>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.AdvancedSearchController.GetMajors">
<summary>
Return a list majors.
</summary>
<returns> All majors</returns>
</member>
<member name="M:Gordon360.Controllers.AdvancedSearchController.GetMinors">
<summary>
Return a list minors.
</summary>
<returns> All minors</returns>
</member>
<member name="M:Gordon360.Controllers.AdvancedSearchController.GetHalls">
<summary>
Return a list minors.
</summary>
<returns> All minors</returns>
</member>
<member name="M:Gordon360.Controllers.AdvancedSearchController.DEPRECATED_GetStates">
<summary>
Return a list states.
</summary>
<remarks>DEPRECATED: Use AddressController instead</remarks>
<returns> All states</returns>
</member>
<member name="M:Gordon360.Controllers.AdvancedSearchController.DEPREACTED_GetCountries">
<summary>
Return a list countries.
</summary>
<remarks>DEPRECATED: Use AddressController instead</remarks>
<returns> All countries</returns>
</member>
<member name="M:Gordon360.Controllers.AdvancedSearchController.GetDepartments">
<summary>
Return a list departments.
</summary>
<returns> All departments</returns>
</member>
<member name="M:Gordon360.Controllers.AdvancedSearchController.GetBuildingsAsync(Gordon360.Models.webSQL.Context.webSQLContext)">
<summary>
Return a list of buildings.
</summary>
<returns> All buildings</returns>
</member>
<member name="M:Gordon360.Controllers.AdvancedSearchController.GetBuildings">
<summary>
Return a list of buildings.
</summary>
<returns> All buildings</returns>
</member>
<member name="M:Gordon360.Controllers.AdvancedSearchController.GetInvolvements">
<summary>
Return a list of involvements' descriptions.
</summary>
<returns> All involvements</returns>
</member>
<member name="M:Gordon360.Controllers.ContentManagementController.GetBannerSlides">
<summary>Get all the banner slides for the dashboard banner</summary>
<returns>A list of all the slides for the banner</returns>
</member>
<member name="M:Gordon360.Controllers.ContentManagementController.PostBannerSlide(Gordon360.Models.ViewModels.BannerSlidePostViewModel)">
<summary>Post a new slide for the dashboard banner</summary>
<returns>The posted banner</returns>
</member>
<member name="M:Gordon360.Controllers.ContentManagementController.DeleteBannerSlide(System.Int32)">
<summary>Remove a slide from the dashboard banner</summary>
<returns>ID of the slide to remove</returns>
</member>
<member name="M:Gordon360.Controllers.DiningController.GetAsync">
<summary>
Gets information about student's dining plan and balance
</summary>
<returns>A DiningInfo object</returns>
</member>
<member name="M:Gordon360.Controllers.EventsController.GetAllEvents">
<summary>
This makes use of our cached request to 25Live, which stores AllEvents
</summary>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.HousingController.DeleteApplication(System.Int32)">
<summary>
Delete an application (and consequently all rows that reference it)
</summary>
<param name="applicationID"> The id of the application to remove </param>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.HousingController.GetApartmentHalls">
<summary>
Get a list of the apartment-style halls
</summary>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.HousingController.GetApplicationID">
<summary>
Get apartment application ID number of currently logged in user if that user is on an existing application
</summary>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.HousingController.GetUserApplicationID(System.String)">
<summary>
Get apartment application ID number for a user if that user is on an existing application
</summary>
<param name="username">username of the profile info</param>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.HousingController.SaveApplication(Gordon360.Models.ViewModels.ApartmentApplicationViewModel)">
<summary>
save application
</summary>
<returns>Returns the application ID number if all the queries succeeded</returns>
</member>
<member name="M:Gordon360.Controllers.HousingController.EditApplication(System.Int32,Gordon360.Models.ViewModels.ApartmentApplicationViewModel)">
<summary>
update existing application (Differentiated by HttpPut instead of HttpPost)
</summary>
<returns>Returns the application ID number if all the queries succeeded</returns>
</member>
<member name="M:Gordon360.Controllers.HousingController.ChangeEditor(System.Int32,Gordon360.Models.ViewModels.ApartmentApplicationViewModel)">
<summary>
change the editor (i.e. primary applicant) of the application
</summary>
<returns>The result of changing the editor</returns>
</member>
<member name="M:Gordon360.Controllers.HousingController.ChangeApplicationDateSubmitted(System.Int32)">
<summary>
change the date an application was submitted
(changes it from null the first time they submit)
</summary>
<returns>The result of changing the date submitted</returns>
</member>
<member name="M:Gordon360.Controllers.HousingController.GetApartmentApplication(System.Int32)">
<summary>Get apartment application info for a given application ID number</summary>
<param name="applicationID">application ID number of the apartment application</param>
<returns>Object of type ApartmentAppViewModel</returns>
</member>
<member name="M:Gordon360.Controllers.HousingController.GetAllApartmentApplication">
<summary>Get apartment application info for all applications if the current user is a housing admin</summary>
<returns>Object of type ApartmentApplicationViewModel</returns>
</member>
<member name="M:Gordon360.Controllers.HousingController.CreateRoomRange(Gordon360.Models.ViewModels.Housing.HallAssignmentRangeViewModel)">
<summary>
Creates a new hall assignment range if it does not overlap with any existing ranges
</summary>
<param name="assignmentRange">The ViewModel that contains the hall ID and room range</param>
<returns>The created Hall_Assignment_Range object</returns>
</member>
<member name="M:Gordon360.Controllers.HousingController.GetAllRoomRanges">
<summary>
Retrieves all room ranges.
</summary>
<returns>A list of room ranges.</returns>
</member>
<member name="M:Gordon360.Controllers.HousingController.DeleteRoomRange(System.Int32)">
<summary>
Deletes a Room Range
</summary>
<param name="rangeId">The ID of the room range to delete</param>
<returns> Returns if completed</returns>
</member>
<member name="M:Gordon360.Controllers.HousingController.AssignRaToRoomRange(RA_AssignmentViewModel)">
<summary>
Assigns an RA to a room range if no RA is currently assigned
</summary>
<param name="assignment">The model containging the RA and range ids</param>
<returns>The created RA_Assigned_Ranges object</returns>
</member>
<member name="M:Gordon360.Controllers.HousingController.GetRangeAssignments">
<summary>
Retrieves the list of all ra roomrange assignments.
</summary>
<returns>Returns a list of all assignments</returns>
</member>
<member name="M:Gordon360.Controllers.HousingController.DeleteAssignment(System.Int32)">
<summary>
Deletes an RA range assignment
</summary>
<param name="rangeId">The Room range of the assignment to delete</param>
<returns> Returns if completed</returns>
</member>
<member name="M:Gordon360.Controllers.HousingController.GetResidentRD(System.String)">
<summary>
Retrieve the RD of the resident's hall based on their hall ID.
</summary>
<param name="hallId">The ID of the hall.</param>
<returns>Returns the RD's details if found, otherwise null.</returns>
</member>
<member name="M:Gordon360.Controllers.HousingController.GetResidentRA(System.String,System.String)">
<summary>
Retrieves the RA assigned to a resident based on their room number and hall ID.
</summary>
<param name="hallId">The ID of the hall.</param>
<param name="roomNumber">The resident's room number.</param>
<returns>Returns the RA's details if found, otherwise null. </returns>
</member>
<member name="M:Gordon360.Controllers.HousingController.GetAllRAs">
<summary>
Retrieves a list of all RAs.
</summary>
<returns>Returns a list of RA_Students containing information about each RA</returns>
</member>
<member name="M:Gordon360.Controllers.HousingController.SetPreferredContact(System.String,System.String)">
<summary>
Sets or updates an RA's preferred contact method
</summary>
<param name="raId">The ID of the RA</param>
<param name="preferredContactMethod">The contact method (e.g., "Phone", "Teams")</param>
<returns>True if the contact method was successfully set</returns>
</member>
<member name="M:Gordon360.Controllers.HousingController.GetRAContact(System.String)">
<summary>
Retrieves the preferred contact information for an RA based on their contact preference.
If the RA has a contact preference set, it will return either their phone number or a Microsoft Teams link
with their email embedded. If no preference exists, the method defaults to returning the RA's phone number.
</summary>
<param name="raId">The ID of the RA whose contact information is being requested.</param>
<returns>An object containing the RAiD, preferred method, and the actual contact.</returns>
</member>
<member name="M:Gordon360.Controllers.HousingController.CreateStatus(Gordon360.Models.ViewModels.RA_Status_ScheduleViewModel,System.String)">
<summary>
Creates a new status event for an RA schedule
</summary>
<param name="Status_Sched">The ViewModel that contains the Schedule ID and RA ID</param>
<param name="raId">the id of the RA setting a status</param>
<returns>The created RA_Status_Schedule object</returns>
</member>
<member name="M:Gordon360.Controllers.HousingController.RA_Checkin(System.String,System.String[])">
<summary>
Checks an RA in
</summary>
<param name="raId">Id of the ra checking in</param>
<param name="HallIDs">The Hall(s) the RA is checking into</param>
<returns>true if RA checked in successfully</returns>
</member>
<member name="M:Gordon360.Controllers.HousingController.GetOnCallRA(System.String)">
<summary>
Gets the on-call RA for a specified hall.
</summary>
<param name="hallid">The ID of the hall</param>
<returns> the on-call RA's details, or a 404 if no RA is on call</returns>
</member>
<member name="M:Gordon360.Controllers.HousingController.GetOnCallRAAllHalls">
<summary>
Gets the on-call RAs for all halls.
</summary>
<returns>The RAs on call with their details</returns>
</member>
<member name="M:Gordon360.Controllers.HousingController.IsRAOnCall(System.String)">
<summary>
Checks if an RA is currently on call.
</summary>
<param name="raId">The ID of the RA</param>
<returns>True if the RA is on call, false otherwise</returns>
</member>
<member name="M:Gordon360.Controllers.HousingController.IsStudentResidential(System.Int32)">
<summary>
Checks if a student is residential
</summary>
<param name="idNum">The ID of the student</param>
<returns>True if the student is a resident</returns>
</member>
<member name="M:Gordon360.Controllers.LogController.Post(System.String)">
<summary>Create a new error log item to be added to database</summary>
<param name="error_message">The error message containing all required and relevant information</param>
<returns></returns>
<remarks>Posts a new message to the service to be added into the database</remarks>
</member>
<member name="M:Gordon360.Controllers.LostAndFoundController.CreateMissingItemReport(Gordon360.Models.ViewModels.MissingItemReportViewModel)">
<summary>
Create a new missing item report with given data
</summary>
<param name="id">The id</param>
<returns>ObjectResult(ID) - An HTTP result code, with the ID of the created report if created successfully</returns>
</member>
<member name="M:Gordon360.Controllers.LostAndFoundController.CreateActionTaken(System.Int32,Gordon360.Models.ViewModels.ActionsTakenViewModel)">
<summary>
Update Missing Item Report with the given id with given data
</summary>
<param name="missingItemId">The id of the report to update</param>
<returns>ObjectResult - the http status code result of the action, with the ID of the action taken</returns>
</member>
<member name="M:Gordon360.Controllers.LostAndFoundController.UpdateMissingItemReport(System.Int32,Gordon360.Models.ViewModels.MissingItemReportViewModel)">
<summary>
Update Missing Item Report with the given id with given data
</summary>
<param name="missingItemId">The id of the report to update</param>
<returns>ObjectResult - the http status code result of the action</returns>
</member>
<member name="M:Gordon360.Controllers.LostAndFoundController.UpdateReportStatus(System.Int32,System.String)">
<summary>
Update the status of the item report with given id to the given status text
</summary>
<param name="missingItemId">The id of the report to update</param>
<param name="status"></param>
<returns>ObjectResult - the http status code result of the action</returns>
</member>
<member name="M:Gordon360.Controllers.LostAndFoundController.GetMissingItems(System.String)">
<summary>
Get the list of missing item reports for the currently authenticated user.
</summary>
<param name="user">Query parameter, default is null and route will get all missing items, or if user is set
route will get missing items for the authenticated user</param>
<returns>ObjectResult - an http status code, with an array of MissingItem objects in the body </returns>
</member>
<member name="M:Gordon360.Controllers.LostAndFoundController.GetMissingItem(System.Int32)">
<summary>
Get a missing item report with given ID.
</summary>
<param name="missingItemId">The id of the report to get</param>
<returns>ObjectResult - an http status code, with a MissingItem object in the body </returns>
</member>
<member name="M:Gordon360.Controllers.LostAndFoundController.GetActionsTaken(System.Int32)">
<summary>
Get all actions taken on a given missing item report.
</summary>
<param name="missingItemId">The id of the report to get</param>
<returns>ObjectResult - an http status code, with a list of Actions Taken objects </returns>
</member>
<member name="M:Gordon360.Controllers.MembershipsController.GetMemberships(System.String,System.String,System.String,System.Collections.Generic.List{System.String})">
<summary>
Get all the memberships associated with a given activity
</summary>
<param name="involvementCode">Optional involvementCode filter</param>
<param name="username">Optional username filter</param>
<param name="sessionCode">Optional session code for which session memberships should be retrieved. Defaults to current session. Use "*" for all sessions.</param>
<param name="participationTypes">Optional list of participation types that should be retrieved. Defaults to all participation types.</param>
<returns>An IEnumerable of the matching MembershipViews</returns>
</member>
<member name="M:Gordon360.Controllers.MembershipsController.GetMembershipCount(System.String,System.String,System.String,System.Collections.Generic.List{System.String})">
<summary>
Gets the number of memberships matching the specified filters
</summary>
<param name="activityCode">Optional activityCode filter</param>
<param name="username">Optional username filter</param>
<param name="sessionCode">Optional session code for which session memberships should be retrieved. Defaults to current session. Use "*" for all sessions.</param>
<param name="participationTypes">Optional list of participation types that should be retrieved. Defaults to all participation types.</param>
<returns>The number of followers of the activity</returns>
</member>
<member name="M:Gordon360.Controllers.MembershipsController.GetMembershipsForActivityAndSession(System.String,System.String)">
<summary>
Get all the memberships associated with a given activity
</summary>
<param name="activityCode">The activity ID</param>
<param name="sessionCode">Optional code of session to get for</param>
<returns>An IEnumerable of the matching MembershipViews</returns>
</member>
<member name="M:Gordon360.Controllers.MembershipsController.GetGroupAdminsForActivity(System.String,System.String)">
<summary>
Gets the group admin memberships associated with a given activity.
</summary>
<param name="activityCode">The activity ID.</param>
<param name="sessionCode">The session code of the activity.</param>
<returns>An IEnumerable of all leader-type memberships for the specified activity.</returns>
</member>
<member name="M:Gordon360.Controllers.MembershipsController.GetActivitySubscribersCountForSession(System.String,System.String)">
<summary>
Gets the number of followers of an activity
</summary>
<param name="activityCode">The activity ID.</param>
<param name="sessionCode">The session code</param>
<returns>The number of followers of the activity</returns>
</member>
<member name="M:Gordon360.Controllers.MembershipsController.GetActivityMembersCountForSession(System.String,System.String)">
<summary>
Gets the number of members (excluding followers) of an activity
</summary>
<param name="activityCode">The activity ID.</param>
<param name="sessionCode">The session code</param>
<returns>The number of members of the activity</returns>
</member>
<member name="M:Gordon360.Controllers.MembershipsController.PostAsync(Gordon360.Models.ViewModels.MembershipUploadViewModel)">
<summary>Create a new membership item to be added to database</summary>
<param name="membershipUpload">The membership item containing all required and relevant information</param>
<returns>The newly created membership as a MembershipView object</returns>
<remarks>Posts a new membership to the server to be added into the database</remarks>
</member>
<member name="M:Gordon360.Controllers.MembershipsController.PutAsync(System.Int32,Gordon360.Models.ViewModels.MembershipUploadViewModel)">
<summary>Update an existing membership item</summary>
<param name="membershipID">The membership id of whichever one is to be changed</param>
<param name="membership">The content within the membership that is to be changed and what it will change to</param>
<remarks>Calls the server to make a call and update the database with the changed information</remarks>
<returns>The updated membership as a MembershipView object</returns>
</member>
<member name="M:Gordon360.Controllers.MembershipsController.SetGroupAdminAsync(System.Int32,System.Boolean)">
<summary>Update an existing membership item to be a group admin or not</summary>
<param name="membershipID">The content within the membership that is to be changed</param>
<param name="isGroupAdmin">The new value of GroupAdmin</param>
<remarks>Calls the server to make a call and update the database with the changed information</remarks>
<returns>The updated membership as a MembershipView object</returns>
</member>
<member name="M:Gordon360.Controllers.MembershipsController.SetPrivacyAsync(System.Int32,System.Boolean)">
<summary>Update an existing membership item to be private or not</summary>
<param name="membershipID">The membership to set the privacy of</param>
<param name="isPrivate">The new value of Privacy for the membership</param>
<remarks>Calls the server to make a call and update the database with the changed information</remarks>
<returns>The updated membership as a MembershipView object</returns>
</member>
<member name="M:Gordon360.Controllers.MembershipsController.Delete(System.Int32)">
<summary>Delete an existing membership</summary>
<param name="membershipID">The identifier for the membership to be deleted</param>
<remarks>Calls the server to make a call and remove the given membership from the database</remarks>
<returns>The deleted membership as a MembershipView object</returns>
</member>
<member name="M:Gordon360.Controllers.NewsController.GetByID(System.Int32)">
<summary>Gets a news item by id from the database</summary>
<param name="newsID">The id of the news item to retrieve</param>
<returns>The news item</returns>
</member>
<member name="M:Gordon360.Controllers.NewsController.GetImage(System.Int32)">
<summary>Gets the base64 image data for an image corresponding
to a student news item. Only used by GO; when we move student news approval
to 360, this will be removed.</summary>
<param name="newsID">The id of the news item to retrieve image from</param>
<returns>base64 string representing image</returns>
</member>
<member name="M:Gordon360.Controllers.NewsController.GetNotExpiredAsync">
Call the service that gets all approved student news entries not yet expired, filtering
out the expired by comparing 2 weeks past date entered to current date
</member>
<member name="M:Gordon360.Controllers.NewsController.GetNewAsync">
Call the service that gets all new and approved student news entries
which have not already expired,
checking novelty by comparing an entry's date entered to 10am on the previous day
</member>
<member name="M:Gordon360.Controllers.NewsController.GetCategories">
Call the service that gets the list of categories
</member>
<member name="M:Gordon360.Controllers.NewsController.GetNewsPersonalUnapprovedAsync">
Call the service that gets all unapproved student news entries (by a particular user)
not yet expired, filtering out the expired news
@TODO: Remove redundant username/id from this and service
@TODO: fix documentation comments
</member>
<member name="M:Gordon360.Controllers.NewsController.Post(Gordon360.Models.ViewModels.StudentNewsUploadViewModel)">
Create a new news item to be added to the database
@TODO: Remove redundant username/id from this and service
@TODO: fix documentation comments
</member>
<member name="M:Gordon360.Controllers.NewsController.Delete(System.Int32)">
<summary>Deletes a news item from the database</summary>
<param name="newsID">The id of the news item to delete</param>
<returns>The deleted news item</returns>
<remarks>The news item must be authored by the user and must not be expired</remarks>
</member>
<member name="M:Gordon360.Controllers.NewsController.EditPosting(System.Int32,Gordon360.Models.ViewModels.StudentNewsUploadViewModel)">
<summary>
(Controller) Edits a news item in the database
</summary>
<param name="newsID">The id of the news item to edit</param>
<param name="studentNewsEdit">The news object that contains updated values</param>
<returns>The updated news item</returns>
<remarks>The news item must be authored by the user and must not be expired and must be unapproved</remarks>
</member>
<member name="M:Gordon360.Controllers.NewsController.EditPostingImage(System.Int32,System.String)">
<summary>
(Controller) Edits a news image in the database
</summary>
<param name="newsID">The id of the news item to edit</param>
<param name="newImageData">The new image string updates the image value</param>
<returns>The updated news item</returns>
<remarks>The news item must be authored by the user and must not be expired and must be unapproved</remarks>
</member>
<member name="M:Gordon360.Controllers.NewsController.UpdateAcceptedStatus(System.Int32,System.Boolean)">
<summary>
Approve or deny a news posting in the database
</summary>
<param name="newsID">The id of the news item to approve</param>
<param name="newsStatusAccepted">The accept status that will apply to the news item</param>
<returns>The approved or denied news item</returns>
<remarks>The news item must not be expired</remarks>
</member>
<member name="M:Gordon360.Controllers.ProfilesController.Get">
<summary>Get profile info of currently logged in user</summary>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.ProfilesController.GetUserProfile(System.String)">
<summary>Get public profile info for a user</summary>
<param name="username">username of the profile info</param>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.ProfilesController.GetAdvisorsAsync(System.String)">
<summary>Get the advisor(s) of a particular student</summary>
<returns>
All advisors of the given student. For each advisor,
provides first name, last name, and username.
</returns>
</member>
<member name="M:Gordon360.Controllers.ProfilesController.GetCliftonStrengths_DEPRECATED(System.String)">
<summary> Gets the clifton strengths of a particular user </summary>
<param name="username"> The username for which to retrieve info </param>
<returns> Clifton strengths of the given user. </returns>
</member>
<member name="M:Gordon360.Controllers.ProfilesController.GetCliftonStrengths(System.String)">
<summary> Gets the clifton strengths of a particular user </summary>
<param name="username"> The username for which to retrieve info </param>
<returns> Clifton strengths of the given user. </returns>
</member>
<member name="M:Gordon360.Controllers.ProfilesController.ToggleCliftonStrengthsPrivacyAsync">
<summary>Toggle privacy of the current user's Clifton Strengths</summary>
<returns>New privacy value</returns>
</member>
<member name="M:Gordon360.Controllers.ProfilesController.GetEmergencyContact(System.String)">
<summary> Gets the emergency contact information of a particular user </summary>
<param name="username"> The username for which to retrieve info </param>
<returns> Emergency contact information of the given user. </returns>
</member>
<member name="M:Gordon360.Controllers.ProfilesController.GetMailInfo">
<summary>Gets the mailbox information of currently logged in user</summary>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.ProfilesController.GetBirthdate">
<summary>Gets the date of birth of the current logged-in user</summary>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.ProfilesController.GetMyImgAsync">
<summary>Get the profile image of currently logged in user</summary>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.ProfilesController.GetImgAsync(System.String)">
<summary>Get the profile image of the given user</summary>
<returns>The profile image(s) that the authenticated user is allowed to see, if any</returns>
</member>
<member name="M:Gordon360.Controllers.ProfilesController.PostImageAsync(Microsoft.AspNetCore.Http.IFormFile)">
<summary>
Set an image for profile
</summary>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.ProfilesController.PostIDImageAsync(Microsoft.AspNetCore.Http.IFormFile)">
<summary>
Set an IDimage for a user
</summary>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.ProfilesController.ResetImage">
<summary>
Reset the profile Image
</summary>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.ProfilesController.UpdateCustomProfile(System.String,Gordon360.Models.CCT.CUSTOM_PROFILE)">
<summary>
Update CUSTOM_PROFILE component
</summary>
<param name="type">The type of component</param>
<param name="value">The value to change the component to</param>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.ProfilesController.UpdateMobilePhoneNumber(System.String)">
<summary>
Update mobile phone number
</summary>
<param name="value">phoneNumber</param>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.ProfilesController.UpdateOfficeLocation(Gordon360.Models.ViewModels.OfficeLocationPatchViewModel)">
<summary>
Update office location (building description and room number)
</summary>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.ProfilesController.UpdateOfficeHours(System.String)">
<summary>
Update office hours
</summary>
<param name="value">office hours</param>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.ProfilesController.UpdateMailStop(System.String)">
<summary>
Update mail location
</summary>
<param name="value">mail location</param>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.ProfilesController.UpdateMobilePrivacyAsync(System.String)">
<summary>
Update privacy of mobile phone number
</summary>
<param name="value">Y or N</param>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.ProfilesController.UpdateImagePrivacyAsync(System.String)">
<summary>
Update privacy of profile image
</summary>
<param name="value">Y or N</param>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.ProfilesController.RequestUpdate(Gordon360.Models.ViewModels.ProfileFieldViewModel[])">
<summary>
Posts fields into CCT.dbo.Information_Change_Request
Sends Alumni Profile Update Email to "[email protected]"
</summary>
<param name="updatedFields">Object with Field's Name and Field's Value, unused Field's Label</param>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.ProfilesController.GetProfileImageOrDefault(System.String)">
<summary>
Gets the profile image at the given path or, if that file does not exist, the 360 default profile image
</summary>
<remarks>
Note that the 360 default profile image is different from a user's default image.
A given user's default image is simply their approved ID photo.
The 360 default profile image, on the other hand, is a stock image of Scottie Lion.
Hence, the 360 default profile image is only used when no other image exists (or should be displayed) for a user.
</remarks>
<param name="imagePath">Path to the profile image to load</param>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.ProfilesController.GetMembershipsByUser(System.String,System.String,System.Collections.Generic.List{System.String})">
<summary>
Fetch memberships that a specific student has been a part of
@TODO: Move security checks to state your business? Or consider changing implementation here
</summary>
<param name="username">The Student Username</param>
<param name="sessionCode">Optional session code or "current". If passed, only memberships from that session will be included. </param>
<param name="participationTypes">Optional participation type. If passed, only memberships of those participation types will be inlcuded</param>
<returns>The membership information that the student is a part of</returns>
</member>
<member name="M:Gordon360.Controllers.ProfilesController.GetMembershipHistory(System.String)">
<summary>
Fetch the history of a user's memberships
</summary>
<param name="username">The Student Username</param>
<returns>The history of that user's membership in involvements</returns>
</member>
<member name="M:Gordon360.Controllers.ProfilesController.GetMailStops">
<summary>
Return a list of mail destinations' descriptions.
</summary>
<returns> All Mail Destinations</returns>
</member>
<member name="M:Gordon360.Controllers.RecIM.ActivitiesController.GetActivities(System.Nullable{System.Boolean})">
<summary>Gets a list of all Activities by parameter </summary>
<param name="active"> Optional active parameter denoting whether or not an activity has been completed </param>
<returns>
All Existing Activities
</returns>
</member>
<member name="M:Gordon360.Controllers.RecIM.ActivitiesController.GetActivityByID(System.Int32)">
<summary>Gets a Activity object by ID number</summary>
<param name="activityID">Activity ID Number</param>
<returns>
Activity object
</returns>
</member>
<member name="M:Gordon360.Controllers.RecIM.ActivitiesController.GetActivityRegistrationStatus(System.Int32)">
<summary>
Niche function to check if the activity is still open for registration
</summary>
<param name="activityID"></param>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.RecIM.ActivitiesController.CreateActivityAsync(Gordon360.Models.ViewModels.RecIM.ActivityUploadViewModel)">
<summary>
Posts Activity into CCT.RecIM.Activity
</summary>
<param name="newActivity">CreateActivityViewModel object with appropriate values</param>
<returns>Posted Activity</returns>
</member>
<member name="M:Gordon360.Controllers.RecIM.ActivitiesController.UpdateActivityAsync(System.Int32,Gordon360.Models.ViewModels.RecIM.ActivityPatchViewModel)">
<summary>
Updates Activity based on input
</summary>
<param name="activityID"> Activity ID</param>
<param name="updatedActivity"> Updated Activity Object </param>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.RecIM.ActivitiesController.DeleteActivityCascadeAsync(System.Int32)">
<summary>
Cascade deletes all DBobjects related to given ActivityID
</summary>
<param name="activityID"></param>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.RecIM.AffiliationsController.GetAllAffiliationDetails">
<summary>
Gets all stored affiliations/halls/clubs with associated
Points/Activities Won : Winning Team
</summary>
</member>
<member name="M:Gordon360.Controllers.RecIM.AffiliationsController.GetAffiliationDetailsByName(System.String)">
<summary>
Gets specific stored affiliation with associated
Points/Activities Won : Winning Team
</summary>
</member>
<member name="M:Gordon360.Controllers.RecIM.AffiliationsController.CreateAffiliation(System.String)">
<summary>
Creates new Affiliation
</summary>
<param name="affiliationName"></param>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.RecIM.AffiliationsController.UpdateAffiliation(System.String,Gordon360.Models.ViewModels.RecIM.AffiliationPatchViewModel)">
<summary>
Updates an affiliation's logo and/or name
</summary>
<param name="affiliationName"></param>
<param name="update">updated instance of affiliation</param>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.RecIM.AffiliationsController.AddPointsToAffilliation(System.String,Gordon360.Models.ViewModels.RecIM.AffiliationPointsUploadViewModel)">
<summary>
Creates new AffiliationPoints entry
(affiliationname, activity where points were attributed, optional points)
</summary>
<param name="vm">put viewmodel</param>
<param name="affiliationName"></param>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.RecIM.AffiliationsController.DeleteAffiliation(System.String)">
<summary>
Deletes affiliation
</summary>
<param name="affiliationName"></param>
</member>
<member name="M:Gordon360.Controllers.RecIM.MatchesController.GetMatches">
<summary>
Get all matches
</summary>
<returns>all matches</returns>
</member>
<member name="M:Gordon360.Controllers.RecIM.MatchesController.GetMatchAttendanceByMatchID(System.Int32)">
<summary>
Get's current match attendance for a specified match
</summary>
<param name="matchID"></param>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.RecIM.MatchesController.GetMatchByID(System.Int32)">
<summary>
Fetches Match by MatchID
</summary>
<param name="matchID"></param>
<returns>The match with the requested matchID (or null)</returns>
</member>
<member name="M:Gordon360.Controllers.RecIM.MatchesController.GetMatchTypes(System.String)">
<summary>
Match lookup
</summary>
<param name="type"></param>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.RecIM.MatchesController.GetSurfaces">
<summary>
Gets all surfaces
</summary>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.RecIM.MatchesController.PostSurfaceAsync(Gordon360.Models.ViewModels.RecIM.SurfaceUploadViewModel)">
<summary>
Creates a new match/series surface
</summary>
<param name="newSurface"></param>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.RecIM.MatchesController.UpdateSurfaceAsync(System.Int32,Gordon360.Models.ViewModels.RecIM.SurfaceUploadViewModel)">
<summary>
Updates a given surface
</summary>
<param name="surfaceID"></param>
<param name="updatedSurface"></param>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.RecIM.MatchesController.DeleteSurfaceAsync(System.Int32)">
<summary>
Deletes surface, points all foreign keys to an unknown surface
to prevent corrupted data
</summary>
<param name="surfaceID"></param>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.RecIM.MatchesController.UpdateStatsAsync(System.Int32,Gordon360.Models.ViewModels.RecIM.MatchStatsPatchViewModel)">
<summary>
Updates Match Scores, Sportsmanship Ratings, and Team Status
</summary>
<param name="matchID"></param>
<param name="updatedMatch"></param>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.RecIM.MatchesController.UpdateMatchAsync(System.Int32,Gordon360.Models.ViewModels.RecIM.MatchPatchViewModel)">
<summary>
Updates Match Start Times and Surfaces
</summary>
<param name="matchID"></param>
<param name="updatedMatch"></param>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.RecIM.MatchesController.CreateMatchAsync(Gordon360.Models.ViewModels.RecIM.MatchUploadViewModel)">
<summary>
Creates Match
</summary>
<param name="newMatch"></param>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.RecIM.MatchesController.DeleteMatchCascadeAsync(System.Int32)">
<summary>
Cascade deletes all DBobjects related to given Match ID
</summary>
<param name="matchID"></param>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.RecIM.MatchesController.PutParticipantAttendanceAsync(System.Int32,Gordon360.Models.ViewModels.RecIM.ParticipantAttendanceViewModel)">
<summary>
creates match attendance
</summary>
<param name="matchID"></param>
<param name="teamID"></param>
<param name="teamAttendanceList">List of attendees for a team</param>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.RecIM.MatchesController.AddParticipantAttendanceAsync(System.Int32,Gordon360.Models.ViewModels.RecIM.MatchAttendance)">
<summary>
Adds single match participant
</summary>
<param name="matchID">match id</param>
<param name="attendee">object holding required username (optional teamID)</param>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.RecIM.MatchesController.DeleteParticipantAttendanceAsync(System.Int32,Gordon360.Models.ViewModels.RecIM.MatchAttendance)">
<summary>
Deletes single match participant
</summary>
<param name="matchID">match id</param>
<param name="attendee">object holding required username (optional teamID)</param>
<returns></returns>
</member>
<member name="M:Gordon360.Controllers.RecIM.ParticipantsController.GetParticipantMatches(System.String)">
<summary>
Used primarily on the rec-im base page, fetches all future/upcoming matches for a participant
</summary>
<param name="username">participant username</param>
<returns>list of upcoming matches of given participant</returns>
</member>
<member name="M:Gordon360.Controllers.RecIM.RecIMAdminController.GetReport(System.DateTime,System.DateTime)">
<summary>
Rec-IM Reporting:
Every semester Rec-IM needs to report, their own client,
information regarding new users, retention of users,
gender ratio, involvements...
This route does not specify semester terms, however, is more
specific in which it can select time constraints from beginning
to end with no limit to time in between
</summary>
<param name="startTime">report start time</param>
<param name="endTime">report end time</param>