-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathawsomAPI.xml
More file actions
386 lines (383 loc) · 25.9 KB
/
Copy pathawsomAPI.xml
File metadata and controls
386 lines (383 loc) · 25.9 KB
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
<?xml version="1.0"?>
<doc>
<assembly>
<name>awsomAPI</name>
</assembly>
<members>
<member name="M:awsomAPI.Controllers.TrialRequestController.#ctor(awsomAPI.Models.AwsomApiContext)">
-------------------------------------------------------------------------------------------------
<summary> Constructor. </summary>
<remarks> Vanvoljg, 18-Jul-19. </remarks>
<param name="context"> The context. </param>
-------------------------------------------------------------------------------------------------
</member>
<member name="M:awsomAPI.Controllers.TrialRequestController.GetTrialRequests">
-------------------------------------------------------------------------------------------------
<summary>
(An Action that handles HTTP GET requests) (Restricted to Roles = Role.Admin) gets trial
requests.
</summary>
<remarks> Vanvoljg, 18-Jul-19. </remarks>
<returns> An asynchronous result that yields the trial requests. </returns>
-------------------------------------------------------------------------------------------------
</member>
<member name="M:awsomAPI.Controllers.TrialRequestController.TrialRequestDetailView(System.Int64)">
-------------------------------------------------------------------------------------------------
<summary>
(An Action that handles HTTP GET requests) (Restricted to Roles = Role.Admin + "," +
Role.User) trial request detail view.
</summary>
<remarks> Vanvoljg, 18-Jul-19. </remarks>
<param name="id"> The identifier. </param>
<returns> An asynchronous result that yields an ActionResult<TrialRequest>. </returns>
-------------------------------------------------------------------------------------------------
</member>
<member name="M:awsomAPI.Controllers.TrialRequestController.SelectStudent(awsomAPI.Models.StudentTeacherSelectedRelation)">
-------------------------------------------------------------------------------------------------
<summary>
(An Action that handles HTTP POST requests) (Restricted to Roles = Role.Admin + "," +
Role.User) select student.
</summary>
<remarks> Vanvoljg, 18-Jul-19. </remarks>
<param name="selection"> The selection. </param>
<returns> An asynchronous result that yields an ActionResult. </returns>
-------------------------------------------------------------------------------------------------
</member>
<member name="M:awsomAPI.Controllers.TrialRequestController.AddNewTrialRequest(awsomAPI.Models.TrialRequest)">
-------------------------------------------------------------------------------------------------
<summary> (An Action that handles HTTP POST requests) adds a new trial request. </summary>
<remarks> Vanvoljg, 18-Jul-19. </remarks>
<param name="trialRequest"> The trial request. </param>
<returns> An asynchronous result that yields an ActionResult<TrialRequest>. </returns>
-------------------------------------------------------------------------------------------------
</member>
<member name="T:awsomAPI.Controllers.UsersController">
-------------------------------------------------------------------------------------------------
<summary> A controller for handling users. </summary>
<remarks> Vanvoljg, 18-Jul-19. </remarks>
-------------------------------------------------------------------------------------------------
</member>
<member name="M:awsomAPI.Controllers.UsersController.#ctor(awsomAPI.Models.AwsomApiContext,Microsoft.Extensions.Configuration.IConfiguration)">
-------------------------------------------------------------------------------------------------
<summary> Constructor. </summary>
<remarks> Vanvoljg, 18-Jul-19. </remarks>
<param name="context"> The context. </param>
<param name="configuration"> The configuration. </param>
-------------------------------------------------------------------------------------------------
</member>
<member name="M:awsomAPI.Controllers.UsersController.GetUsers">
-------------------------------------------------------------------------------------------------
<summary>
(An Action that handles HTTP GET requests) (Restricted to Roles = Role.Admin) gets the
users.
</summary>
<remarks> Vanvoljg, 18-Jul-19. </remarks>
<returns> An asynchronous result that yields all the users. </returns>
-------------------------------------------------------------------------------------------------
</member>
<member name="M:awsomAPI.Controllers.UsersController.GetUser(System.Int64)">
-------------------------------------------------------------------------------------------------
<summary> (An Action that handles HTTP GET requests) gets a user. </summary>
<remarks> Vanvoljg, 18-Jul-19. </remarks>
<param name="id"> The identifier. </param>
<returns> An asynchronous result that yields the user. </returns>
-------------------------------------------------------------------------------------------------
</member>
<member name="M:awsomAPI.Controllers.UsersController.Signin(awsomAPI.Models.User)">
-------------------------------------------------------------------------------------------------
<summary>
(An Action that handles HTTP POST requests) signins the given user from frontend.
</summary>
<remarks> Vanvoljg, 18-Jul-19. </remarks>
<param name="userFromFrontend"> The user from frontend. </param>
<returns> An asynchronous result that yields an ActionResult<User>. </returns>
-------------------------------------------------------------------------------------------------
</member>
<member name="M:awsomAPI.Controllers.UsersController.AddUser(awsomAPI.Models.User)">
-------------------------------------------------------------------------------------------------
<summary> (An Action that handles HTTP POST requests) adds a user. </summary>
<remarks> Vanvoljg, 18-Jul-19. </remarks>
<param name="user"> The user. </param>
<returns> An asynchronous result that yields an ActionResult<User>. </returns>
-------------------------------------------------------------------------------------------------
</member>
<member name="T:awsomAPI.Models.AwsomApiContext">
-------------------------------------------------------------------------------------------------
<summary> An awsom API context. </summary>
<remarks> Vanvoljg, 18-Jul-19. </remarks>
-------------------------------------------------------------------------------------------------
</member>
<member name="M:awsomAPI.Models.AwsomApiContext.#ctor(Microsoft.EntityFrameworkCore.DbContextOptions{awsomAPI.Models.AwsomApiContext})">
-------------------------------------------------------------------------------------------------
<summary> Constructor. </summary>
<remarks> Vanvoljg, 18-Jul-19. </remarks>
<param name="options"> Options for controlling the operation. </param>
-------------------------------------------------------------------------------------------------
</member>
<member name="P:awsomAPI.Models.AwsomApiContext.Users">
-------------------------------------------------------------------------------------------------
<summary> Gets or sets the users. </summary>
<value> The users. </value>
-------------------------------------------------------------------------------------------------
</member>
<member name="P:awsomAPI.Models.AwsomApiContext.TrialRequests">
-------------------------------------------------------------------------------------------------
<summary> Gets or sets the trial requests. </summary>
<value> The trial requests. </value>
-------------------------------------------------------------------------------------------------
</member>
<member name="P:awsomAPI.Models.AwsomApiContext.TeacherSelections">
-------------------------------------------------------------------------------------------------
<summary> Gets or sets the teacher selections. </summary>
<value> The teacher selections. </value>
-------------------------------------------------------------------------------------------------
</member>
<member name="T:awsomAPI.Models.Role">
-------------------------------------------------------------------------------------------------
<summary> A role model. </summary>
<remarks> Vanvoljg, 18-Jul-19. </remarks>
-------------------------------------------------------------------------------------------------
</member>
<member name="T:awsomAPI.Models.StudentTeacherSelectedRelation">
-------------------------------------------------------------------------------------------------
<summary> A student teacher selected relation. </summary>
<remarks> Vanvoljg, 18-Jul-19. </remarks>
-------------------------------------------------------------------------------------------------
</member>
<member name="P:awsomAPI.Models.StudentTeacherSelectedRelation.Id">
-------------------------------------------------------------------------------------------------
<summary> Gets or sets the identifier. </summary>
<value> The identifier. </value>
-------------------------------------------------------------------------------------------------
</member>
<member name="P:awsomAPI.Models.StudentTeacherSelectedRelation.TrialRequestId">
-------------------------------------------------------------------------------------------------
<summary> Gets or sets the identifier of the trial request. </summary>
<value> The identifier of the trial request. </value>
-------------------------------------------------------------------------------------------------
</member>
<member name="P:awsomAPI.Models.StudentTeacherSelectedRelation.TeacherId">
-------------------------------------------------------------------------------------------------
<summary> Gets or sets the identifier of the teacher. </summary>
<value> The identifier of the teacher. </value>
-------------------------------------------------------------------------------------------------
</member>
<member name="T:awsomAPI.Models.TrialRequest">
-------------------------------------------------------------------------------------------------
<summary> A trial request. </summary>
<remarks> Vanvoljg, 18-Jul-19. </remarks>
-------------------------------------------------------------------------------------------------
</member>
<member name="P:awsomAPI.Models.TrialRequest.Id">
-------------------------------------------------------------------------------------------------
<summary> Gets or sets the identifier. </summary>
<value> The identifier. </value>
-------------------------------------------------------------------------------------------------
</member>
<member name="P:awsomAPI.Models.TrialRequest.ParentName">
-------------------------------------------------------------------------------------------------
<summary> Gets or sets the name of the parent. </summary>
<value> The name of the parent. </value>
-------------------------------------------------------------------------------------------------
</member>
<member name="P:awsomAPI.Models.TrialRequest.StudentName">
-------------------------------------------------------------------------------------------------
<summary> Gets or sets the name of the student. </summary>
<value> The name of the student. </value>
-------------------------------------------------------------------------------------------------
</member>
<member name="P:awsomAPI.Models.TrialRequest.StudentBirthDate">
-------------------------------------------------------------------------------------------------
<summary> Gets or sets the student birth date. </summary>
<value> The student birth date. </value>
-------------------------------------------------------------------------------------------------
</member>
<member name="P:awsomAPI.Models.TrialRequest.Email">
-------------------------------------------------------------------------------------------------
<summary> Gets or sets the email. </summary>
<value> The email. </value>
-------------------------------------------------------------------------------------------------
</member>
<member name="P:awsomAPI.Models.TrialRequest.Phone">
-------------------------------------------------------------------------------------------------
<summary> Gets or sets the phone. </summary>
<value> The phone. </value>
-------------------------------------------------------------------------------------------------
</member>
<member name="P:awsomAPI.Models.TrialRequest.Address">
-------------------------------------------------------------------------------------------------
<summary> Gets or sets the address. </summary>
<value> The address. </value>
-------------------------------------------------------------------------------------------------
</member>
<member name="P:awsomAPI.Models.TrialRequest.City">
-------------------------------------------------------------------------------------------------
<summary> Gets or sets the city. </summary>
<value> The city. </value>
-------------------------------------------------------------------------------------------------
</member>
<member name="P:awsomAPI.Models.TrialRequest.ZipCode">
-------------------------------------------------------------------------------------------------
<summary> Gets or sets the zip code. </summary>
<value> The zip code. </value>
-------------------------------------------------------------------------------------------------
</member>
<member name="P:awsomAPI.Models.TrialRequest.Region">
-------------------------------------------------------------------------------------------------
<summary> Gets or sets the region. </summary>
<value> The region. </value>
-------------------------------------------------------------------------------------------------
</member>
<member name="P:awsomAPI.Models.TrialRequest.Instrument">
-------------------------------------------------------------------------------------------------
<summary> Gets or sets the instrument. </summary>
<value> The instrument. </value>
-------------------------------------------------------------------------------------------------
</member>
<member name="P:awsomAPI.Models.TrialRequest.HasInstrument">
-------------------------------------------------------------------------------------------------
<summary> Gets or sets the has instrument. </summary>
<value> The has instrument. </value>
-------------------------------------------------------------------------------------------------
</member>
<member name="P:awsomAPI.Models.TrialRequest.Availability">
-------------------------------------------------------------------------------------------------
<summary> Gets or sets the availability. </summary>
<value> The availability. </value>
-------------------------------------------------------------------------------------------------
</member>
<member name="P:awsomAPI.Models.TrialRequest.Experience">
-------------------------------------------------------------------------------------------------
<summary> Gets or sets the experience. </summary>
<value> The experience. </value>
-------------------------------------------------------------------------------------------------
</member>
<member name="P:awsomAPI.Models.TrialRequest.Notes">
-------------------------------------------------------------------------------------------------
<summary> Gets or sets the notes. </summary>
<value> The notes. </value>
-------------------------------------------------------------------------------------------------
</member>
<member name="T:awsomAPI.Models.User">
-------------------------------------------------------------------------------------------------
<summary> A user. </summary>
<remarks> Vanvoljg, 18-Jul-19. </remarks>
-------------------------------------------------------------------------------------------------
</member>
<member name="P:awsomAPI.Models.User.Id">
-------------------------------------------------------------------------------------------------
<summary> Gets or sets the identifier. </summary>
<value> The identifier. </value>
-------------------------------------------------------------------------------------------------
</member>
<member name="P:awsomAPI.Models.User.Name">
-------------------------------------------------------------------------------------------------
<summary> Gets or sets the name. </summary>
<value> The name. </value>
-------------------------------------------------------------------------------------------------
</member>
<member name="P:awsomAPI.Models.User.Email">
-------------------------------------------------------------------------------------------------
<summary> Gets or sets the email. </summary>
<value> The email. </value>
-------------------------------------------------------------------------------------------------
</member>
<member name="P:awsomAPI.Models.User.Role">
-------------------------------------------------------------------------------------------------
<summary> Gets or sets the role. </summary>
<value> The role. </value>
-------------------------------------------------------------------------------------------------
</member>
<member name="P:awsomAPI.Models.User.Password">
-------------------------------------------------------------------------------------------------
<summary> Gets or sets the password. </summary>
<value> The password. </value>
-------------------------------------------------------------------------------------------------
</member>
<member name="P:awsomAPI.Models.User.Region">
-------------------------------------------------------------------------------------------------
<summary> Gets or sets the region. </summary>
<value> The region. </value>
-------------------------------------------------------------------------------------------------
</member>
<member name="P:awsomAPI.Models.User.Address">
-------------------------------------------------------------------------------------------------
<summary> Gets or sets the address. </summary>
<value> The address. </value>
-------------------------------------------------------------------------------------------------
</member>
<member name="P:awsomAPI.Models.User.City">
-------------------------------------------------------------------------------------------------
<summary> Gets or sets the city. </summary>
<value> The city. </value>
-------------------------------------------------------------------------------------------------
</member>
<member name="P:awsomAPI.Models.User.ZipCode">
-------------------------------------------------------------------------------------------------
<summary> Gets or sets the zip. </summary>
<value> The zip. </value>
-------------------------------------------------------------------------------------------------
</member>
<member name="P:awsomAPI.Models.User.Token">
-------------------------------------------------------------------------------------------------
<summary> Gets or sets the token. </summary>
<value> The token. </value>
-------------------------------------------------------------------------------------------------
</member>
<member name="T:awsomAPI.Program">
-------------------------------------------------------------------------------------------------
<summary> A program. </summary>
<remarks> Vanvoljg, 18-Jul-19. </remarks>
-------------------------------------------------------------------------------------------------
</member>
<member name="M:awsomAPI.Program.Main(System.String[])">
-------------------------------------------------------------------------------------------------
<summary> Main entry-point for this application. </summary>
<remarks> Vanvoljg, 18-Jul-19. </remarks>
<param name="args"> An array of command-line argument strings. </param>
-------------------------------------------------------------------------------------------------
</member>
<member name="M:awsomAPI.Program.CreateWebHostBuilder(System.String[])">
-------------------------------------------------------------------------------------------------
<summary> Creates web host builder. </summary>
<remarks> Vanvoljg, 18-Jul-19. </remarks>
<param name="args"> An array of command-line argument strings. </param>
<returns> The new web host builder. </returns>
-------------------------------------------------------------------------------------------------
</member>
<member name="T:awsomAPI.Startup">
-------------------------------------------------------------------------------------------------
<summary> A startup. </summary>
<remarks> Vanvoljg, 18-Jul-19. </remarks>
-------------------------------------------------------------------------------------------------
</member>
<member name="P:awsomAPI.Startup.Configuration">
-------------------------------------------------------------------------------------------------
<summary> Gets the configuration. </summary>
<value> The configuration. </value>
-------------------------------------------------------------------------------------------------
</member>
<member name="M:awsomAPI.Startup.#ctor(Microsoft.Extensions.Configuration.IConfiguration)">
-------------------------------------------------------------------------------------------------
<summary> Constructor. </summary>
<remarks> Vanvoljg, 18-Jul-19. </remarks>
<param name="configuration"> The configuration. </param>
-------------------------------------------------------------------------------------------------
</member>
<member name="M:awsomAPI.Startup.ConfigureServices(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
-------------------------------------------------------------------------------------------------
<summary> Configure services. </summary>
<remarks> Vanvoljg, 18-Jul-19. </remarks>
<param name="services"> The services. </param>
-------------------------------------------------------------------------------------------------
</member>
<member name="M:awsomAPI.Startup.Configure(Microsoft.AspNetCore.Builder.IApplicationBuilder,Microsoft.AspNetCore.Hosting.IHostingEnvironment)">
-------------------------------------------------------------------------------------------------
<summary> Configures. </summary>
<remarks> Vanvoljg, 18-Jul-19. </remarks>
<param name="app"> The application. </param>
<param name="env"> The environment. </param>
-------------------------------------------------------------------------------------------------
</member>
</members>
</doc>