-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapi.html
555 lines (546 loc) · 92.2 KB
/
api.html
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
<!DOCTYPE HTML><html><head><title>Respon_sum API API documentation</title><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta name="generator" content="https://github.com/raml2html/raml2html 7.6.0"><link rel="stylesheet" href="https://netdna.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"> <header id="header">
<a href="index.html" class="logo">Home</a>
<ul class="actions special">
<li><a href = "index.html#targetMain" class="button">Back</a></li>
</ul>
</header><script type="text/javascript" src="https://code.jquery.com/jquery-1.11.0.min.js"></script><script type="text/javascript" src="https://netdna.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script><script type="text/javascript">
$(document).ready(function() {
$('.page-header pre code, .top-resource-description pre code, .modal-body pre code').each(function(i, block) {
hljs.highlightBlock(block);
});
$('[data-toggle]').click(function() {
var selector = $(this).data('target') + ' pre code';
$(selector).each(function(i, block) {
hljs.highlightBlock(block);
});
});
// open modal on hashes like #_action_get
$(window).bind('hashchange', function(e) {
var anchor_id = document.location.hash.substr(1); //strip #
var element = $('#' + anchor_id);
// do we have such element + is it a modal? --> show it
if (element.length && element.hasClass('modal')) {
element.modal('show');
}
});
// execute hashchange on first page load
$(window).trigger('hashchange');
// remove url fragment on modal hide
$('.modal').on('hidden.bs.modal', function() {
try {
if (history && history.replaceState) {
history.replaceState({}, '', '#');
}
} catch(e) {}
});
});
</script><style>
.hljs {
background: transparent;
}
.parent {
color: #999;
}
.list-group-item > .badge {
float: none;
margin-right: 6px;
}
.panel-title > .methods {
float: right;
}
.badge {
border-radius: 0;
text-transform: uppercase;
width: 70px;
font-weight: normal;
color: #f3f3f6;
line-height: normal;
}
.badge_get {
background-color: #63a8e2;
}
.badge_post {
background-color: #6cbd7d;
}
.badge_put {
background-color: #22bac4;
}
.badge_delete {
background-color: #d26460;
}
.badge_patch {
background-color: #ccc444;
}
.list-group,
.panel-group {
margin-bottom: 0;
}
.panel-group .panel+.panel-white {
margin-top: 0;
}
.panel-group .panel-white {
border-bottom: 1px solid #F5F5F5;
border-radius: 0;
}
.panel-white:last-child {
border-bottom-color: white;
-webkit-box-shadow: none;
box-shadow: none;
}
.panel-white .panel-heading {
background: white;
}
.tab-pane ul {
padding-left: 2em;
}
.tab-pane h1 {
font-size: 1.3em;
}
.tab-pane h2 {
font-size: 1.2em;
padding-bottom: 4px;
border-bottom: 1px solid #ddd;
}
.tab-pane h3 {
font-size: 1.1em;
}
.tab-content {
border-left: 1px solid #ddd;
border-right: 1px solid #ddd;
border-bottom: 1px solid #ddd;
padding: 10px;
}
#sidebar {
margin-top: 30px;
padding-right: 5px;
overflow: auto;
height: 90%;
}
.top-resource-description {
border-bottom: 1px solid #ddd;
background: #fcfcfc;
padding: 15px 15px 0 15px;
margin: -15px -15px 10px -15px;
}
.resource-description {
border-bottom: 1px solid #fcfcfc;
background: #fcfcfc;
padding: 15px 15px 0 15px;
margin: -15px -15px 10px -15px;
}
.resource-description p:last-child {
margin: 0;
}
.list-group .badge {
float: left;
}
.method_description {
margin-left: 85px;
}
.method_description p:last-child {
margin: 0;
}
.list-group-item {
cursor: pointer;
}
.list-group-item:hover {
background-color: #f5f5f5;
}
pre code {
overflow: auto;
word-wrap: normal;
white-space: pre;
}
.items {
background: #f5f5f5;
color: #333;
border: 1px solid #ccc;
border-radius: 4px;
padding: 9.5px;
margin: 0 0 10px;
font-size: 13px;
line-height: 1.42857143;
}
.examples {
margin-left: 0.5em;
}
.resource-modal li > ul {
margin-bottom: 1em;
}
.required {
color: #f00;
}
</style></head><body data-spy="scroll" data-target="#sidebar"><div class="container"><div class="row"><div class="col-md-9" role="main"><div class="page-header"><h1>Respon_sum API documentation <small>version v1</small></h1><p>Welcome to Responsum! I built this project for my professor to use in a class of 135 students. It is able to perform live quizzing or assesment questions and can done in person or remote. The benefit of Responsum incldues a searchable, pageable, and orderable database of all the questions and answers. For me as a student, this helps a lot with studying for exams and focusing on specific topics I plan to work on.</p><p>Try clicking on the GET, PUT, POST, DELETE Colored Buttons!</p><ul><li><strong>version</strong>: <em><span class="required">required</span>(v1)</em></li></ul></div><div class="panel panel-default"><div class="panel-heading"><h3 id="students" class="panel-title">/students</h3></div><div class="panel-body"><div class="top-resource-description"><p>Collection of all registered students.</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_students"><span class="parent"></span>/students</a> <span class="methods"><a href="#students_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_students" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#students_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Create a new student.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="students_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent"></span>/students</h4></div><div class="modal-body"><div class="alert alert-info"><p>Create a new student.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#students_post_request" data-toggle="tab">Request</a></li><li><a href="#students_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="students_post_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: json</p><p><strong>Content</strong>:</p><pre><code>{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema",
"id": "http://jsonschema.net",
"properties": {
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"studentNumber": {
"type": "string"
},
"institution": {
"type": "string"
}
},
"required": ["name", "email", "studentNumber", "institution"],
"additionalProperties": false
}
</code></pre></div><div class="tab-pane" id="students_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>:</p><pre><code>{
"$type": "object",
"$schema": "http://json-schema.org/draft-07/schema",
"id": "http://jsonschema.net",
"properties": {
"id": {
"type": "string"
}
},
"additionalProperties": false
}
</code></pre></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_students__studentid_"><span class="parent">/students</span>/{studentId}</a> <span class="methods"><a href="#students__studentid__get"><span class="badge badge_get">get</span></a> <a href="#students__studentid__put"><span class="badge badge_put">put</span></a> <a href="#students__studentid__delete"><span class="badge badge_delete">delete</span></a></span></h4></div><div id="panel_students__studentid_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#students__studentid__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get information about a student.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#students__studentid__put'" class="list-group-item"><span class="badge badge_put">put</span><div class="method_description"><p>Update a student's information.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#students__studentid__delete'" class="list-group-item"><span class="badge badge_delete">delete</span><div class="method_description"><p>Delete a student account.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="students__studentid__get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/students</span>/{studentId}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get information about a student.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#students__studentid__get_request" data-toggle="tab">Request</a></li><li><a href="#students__studentid__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="students__studentid__get_request"><h3>URI Parameters</h3><ul><li><strong>studentId</strong>: <em><span class="required">required</span>(string)</em></li></ul></div><div class="tab-pane" id="students__studentid__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: json</p><p><strong>Content</strong>:</p><pre><code>{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema",
"id": "http://jsonschema.net",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"studentNumber": {
"type": "string"
},
"institution": {
"type": "string"
},
"performance": {
"$ref": "stats.json"
}
},
"required": ["id", "name", "studentNumber", "institution", "performance"],
"additionalProperties": false
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="students__studentid__put"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put</span> <span class="parent">/students</span>/{studentId}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Update a student's information.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#students__studentid__put_request" data-toggle="tab">Request</a></li></ul><div class="tab-content"><div class="tab-pane active" id="students__studentid__put_request"><h3>URI Parameters</h3><ul><li><strong>studentId</strong>: <em><span class="required">required</span>(string)</em></li></ul><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: json</p><p><strong>Content</strong>:</p><pre><code>{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema",
"id": "http://jsonschema.net",
"properties": {
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"studentNumber": {
"type": "string"
},
"institution": {
"type": "string"
}
},
"required": ["name", "email", "studentNumber", "institution"],
"additionalProperties": false
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="students__studentid__delete"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_delete">delete</span> <span class="parent">/students</span>/{studentId}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Delete a student account.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#students__studentid__delete_request" data-toggle="tab">Request</a></li></ul><div class="tab-content"><div class="tab-pane active" id="students__studentid__delete_request"><h3>URI Parameters</h3><ul><li><strong>studentId</strong>: <em><span class="required">required</span>(string)</em></li></ul></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_students__studentid__responses"><span class="parent">/students/{studentId}</span>/responses</a> <span class="methods"><a href="#students__studentid__responses_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_students__studentid__responses" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>A list of all the responses the student has ever made.</p></div><div class="list-group"><div onclick="window.location.href = '#students__studentid__responses_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get the paginated list of responses made by the student. If ordering by "correct" or "wrong", responses matching the criteria will be placed at the top. Then, they will be sorted by type of response in one batch. Within each batch, they will be sorted by recency.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="students__studentid__responses_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/students/{studentId}</span>/responses</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get the paginated list of responses made by the student. If ordering by "correct" or "wrong", responses matching the criteria will be placed at the top. Then, they will be sorted by type of response in one batch. Within each batch, they will be sorted by recency.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#students__studentid__responses_get_request" data-toggle="tab">Request</a></li></ul><div class="tab-content"><div class="tab-pane active" id="students__studentid__responses_get_request"><h3>URI Parameters</h3><ul><li><strong>studentId</strong>: <em><span class="required">required</span>(string)</em></li></ul><h3>Query Parameters</h3><ul><li><strong>offset</strong>: <em>(integer - default: 0)</em><p>Skip over a number of elements by specifying an offset value for the query.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>20</code></pre></div></li><li><strong>limit</strong>: <em>(integer - default: 10)</em><p>Limit the number of elements on the response.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>80</code></pre></div></li><li><strong>orderBy</strong>: <em>(one of recency, correct, wrong - default: recency)</em><p>Order by field</p></li><li><strong>order</strong>: <em>(one of desc, asc - default: desc)</em><p>Order</p></li></ul><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>:</p><pre><code>{
"type": "array",
"$schema": "http://json-schema.org/draft-07/schema",
"id": "http://jsonschema.net",
"items": {
"$ref": "response-retrieve.json"
}
}
</code></pre></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_students__studentid__current_classes"><span class="parent">/students/{studentId}</span>/current-classes</a> <span class="methods"><a href="#students__studentid__current_classes_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_students__studentid__current_classes" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>A list of active classes in which the student is currently registered.</p></div><div class="list-group"><div onclick="window.location.href = '#students__studentid__current_classes_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get the paginated list of classes in which the student is currently registered. The classes are sorted descending by date joined.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="students__studentid__current_classes_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/students/{studentId}</span>/current-classes</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get the paginated list of classes in which the student is currently registered. The classes are sorted descending by date joined.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#students__studentid__current_classes_get_request" data-toggle="tab">Request</a></li></ul><div class="tab-content"><div class="tab-pane active" id="students__studentid__current_classes_get_request"><h3>URI Parameters</h3><ul><li><strong>studentId</strong>: <em><span class="required">required</span>(string)</em></li></ul><h3>Query Parameters</h3><ul><li><strong>offset</strong>: <em>(integer - default: 0)</em><p>Skip over a number of elements by specifying an offset value for the query.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>20</code></pre></div></li><li><strong>limit</strong>: <em>(integer - default: 10)</em><p>Limit the number of elements on the response.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>80</code></pre></div></li></ul><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>:</p><pre><code>{
"type": "array",
"$schema": "http://json-schema.org/draft-07/schema",
"id": "http://jsonschema.net",
"items": {
"$ref": "class-retrieve.json"
}
}
</code></pre></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_students__studentid__past_classes"><span class="parent">/students/{studentId}</span>/past-classes</a> <span class="methods"><a href="#students__studentid__past_classes_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_students__studentid__past_classes" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>A list of inactive classes in which the student was previously registered.</p></div><div class="list-group"><div onclick="window.location.href = '#students__studentid__past_classes_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get the paginated list of classes in which the student was previously registered. The classes are sorted descending by date joined.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="students__studentid__past_classes_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/students/{studentId}</span>/past-classes</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get the paginated list of classes in which the student was previously registered. The classes are sorted descending by date joined.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#students__studentid__past_classes_get_request" data-toggle="tab">Request</a></li></ul><div class="tab-content"><div class="tab-pane active" id="students__studentid__past_classes_get_request"><h3>URI Parameters</h3><ul><li><strong>studentId</strong>: <em><span class="required">required</span>(string)</em></li></ul><h3>Query Parameters</h3><ul><li><strong>offset</strong>: <em>(integer - default: 0)</em><p>Skip over a number of elements by specifying an offset value for the query.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>20</code></pre></div></li><li><strong>limit</strong>: <em>(integer - default: 10)</em><p>Limit the number of elements on the response.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>80</code></pre></div></li></ul><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>:</p><pre><code>{
"type": "array",
"$schema": "http://json-schema.org/draft-07/schema",
"id": "http://jsonschema.net",
"items": {
"$ref": "class-retrieve.json"
}
}
</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="instructors" class="panel-title">/instructors</h3></div><div class="panel-body"><div class="top-resource-description"><p>Collection of all registered instructors.</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_instructors"><span class="parent"></span>/instructors</a> <span class="methods"><a href="#instructors_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_instructors" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#instructors_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Create a new instructor.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="instructors_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent"></span>/instructors</h4></div><div class="modal-body"><div class="alert alert-info"><p>Create a new instructor.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#instructors_post_request" data-toggle="tab">Request</a></li><li><a href="#instructors_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="instructors_post_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: json</p><p><strong>Content</strong>:</p><pre><code>{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema",
"id": "http://jsonschema.net",
"properties": {
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"institution": {
"type": "string"
}
},
"required": ["name", "email", "institution"],
"additionalProperties": false
}
</code></pre></div><div class="tab-pane" id="instructors_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>:</p><pre><code>{
"$type": "object",
"$schema": "http://json-schema.org/draft-07/schema",
"id": "http://jsonschema.net",
"properties": {
"id": {
"type": "string"
}
},
"additionalProperties": false
}
</code></pre></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_instructors__instructorid_"><span class="parent">/instructors</span>/{instructorId}</a> <span class="methods"><a href="#instructors__instructorid__get"><span class="badge badge_get">get</span></a> <a href="#instructors__instructorid__put"><span class="badge badge_put">put</span></a> <a href="#instructors__instructorid__delete"><span class="badge badge_delete">delete</span></a></span></h4></div><div id="panel_instructors__instructorid_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#instructors__instructorid__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get information about an instructor.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#instructors__instructorid__put'" class="list-group-item"><span class="badge badge_put">put</span><div class="method_description"><p>Update an instructor's information.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#instructors__instructorid__delete'" class="list-group-item"><span class="badge badge_delete">delete</span><div class="method_description"><p>Delete an instructor account.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="instructors__instructorid__get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/instructors</span>/{instructorId}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get information about an instructor.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#instructors__instructorid__get_request" data-toggle="tab">Request</a></li><li><a href="#instructors__instructorid__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="instructors__instructorid__get_request"><h3>URI Parameters</h3><ul><li><strong>instructorId</strong>: <em><span class="required">required</span>(string)</em></li></ul></div><div class="tab-pane" id="instructors__instructorid__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="instructors__instructorid__put"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put</span> <span class="parent">/instructors</span>/{instructorId}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Update an instructor's information.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#instructors__instructorid__put_request" data-toggle="tab">Request</a></li></ul><div class="tab-content"><div class="tab-pane active" id="instructors__instructorid__put_request"><h3>URI Parameters</h3><ul><li><strong>instructorId</strong>: <em><span class="required">required</span>(string)</em></li></ul><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: json</p><p><strong>Content</strong>:</p><pre><code>{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema",
"id": "http://jsonschema.net",
"properties": {
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"institution": {
"type": "string"
}
},
"required": ["name", "email", "institution"],
"additionalProperties": false
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="instructors__instructorid__delete"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_delete">delete</span> <span class="parent">/instructors</span>/{instructorId}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Delete an instructor account.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#instructors__instructorid__delete_request" data-toggle="tab">Request</a></li></ul><div class="tab-content"><div class="tab-pane active" id="instructors__instructorid__delete_request"><h3>URI Parameters</h3><ul><li><strong>instructorId</strong>: <em><span class="required">required</span>(string)</em></li></ul></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_instructors__instructorid__questions"><span class="parent">/instructors/{instructorId}</span>/questions</a> <span class="methods"><a href="#instructors__instructorid__questions_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_instructors__instructorid__questions" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>A list of all questions the instructor has ever asked.</p></div><div class="list-group"><div onclick="window.location.href = '#instructors__instructorid__questions_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get the paginated and searchable list of questions asked by the instructor.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="instructors__instructorid__questions_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/instructors/{instructorId}</span>/questions</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get the paginated and searchable list of questions asked by the instructor.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#instructors__instructorid__questions_get_request" data-toggle="tab">Request</a></li><li><a href="#instructors__instructorid__questions_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="instructors__instructorid__questions_get_request"><h3>URI Parameters</h3><ul><li><strong>instructorId</strong>: <em><span class="required">required</span>(string)</em></li></ul><h3>Query Parameters</h3><ul><li><strong>offset</strong>: <em>(integer - default: 0)</em><p>Skip over a number of elements by specifying an offset value for the query.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>20</code></pre></div></li><li><strong>limit</strong>: <em>(integer - default: 10)</em><p>Limit the number of elements on the response.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>80</code></pre></div></li><li><strong>orderBy</strong>: <em>(one of recency, correctPercent, incorrectPercent, unrespondedPercent - default: <<default>>)</default></em><p>Order by field</p></li><li><strong>order</strong>: <em>(one of desc, asc - default: desc)</em><p>Order</p></li><li><strong>query</strong>: <em>(string)</em><p>Query to search for. Searches in question and correct answer texts.</p></li></ul></div><div class="tab-pane" id="instructors__instructorid__questions_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_instructors__instructorid__current_classes"><span class="parent">/instructors/{instructorId}</span>/current-classes</a> <span class="methods"><a href="#instructors__instructorid__current_classes_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_instructors__instructorid__current_classes" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>A list of all active classes currently owned by the instructor.</p></div><div class="list-group"><div onclick="window.location.href = '#instructors__instructorid__current_classes_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get the paginated list of classes currently active. The classes are sorted descending by date joined.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="instructors__instructorid__current_classes_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/instructors/{instructorId}</span>/current-classes</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get the paginated list of classes currently active. The classes are sorted descending by date joined.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#instructors__instructorid__current_classes_get_request" data-toggle="tab">Request</a></li></ul><div class="tab-content"><div class="tab-pane active" id="instructors__instructorid__current_classes_get_request"><h3>URI Parameters</h3><ul><li><strong>instructorId</strong>: <em><span class="required">required</span>(string)</em></li></ul><h3>Query Parameters</h3><ul><li><strong>offset</strong>: <em>(integer - default: 0)</em><p>Skip over a number of elements by specifying an offset value for the query.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>20</code></pre></div></li><li><strong>limit</strong>: <em>(integer - default: 10)</em><p>Limit the number of elements on the response.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>80</code></pre></div></li></ul><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>:</p><pre><code>{
"type": "array",
"$schema": "http://json-schema.org/draft-07/schema",
"id": "http://jsonschema.net",
"items": {
"$ref": "class-retrieve.json"
}
}
</code></pre></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_instructors__instructorid__past_classes"><span class="parent">/instructors/{instructorId}</span>/past-classes</a> <span class="methods"><a href="#instructors__instructorid__past_classes_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_instructors__instructorid__past_classes" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>A list of all inactive classes previously owned by the instructor.</p></div><div class="list-group"><div onclick="window.location.href = '#instructors__instructorid__past_classes_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get the paginated list of classes previously owned by the instructor. The classes are sorted descending by date joined.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="instructors__instructorid__past_classes_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/instructors/{instructorId}</span>/past-classes</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get the paginated list of classes previously owned by the instructor. The classes are sorted descending by date joined.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#instructors__instructorid__past_classes_get_request" data-toggle="tab">Request</a></li></ul><div class="tab-content"><div class="tab-pane active" id="instructors__instructorid__past_classes_get_request"><h3>URI Parameters</h3><ul><li><strong>instructorId</strong>: <em><span class="required">required</span>(string)</em></li></ul><h3>Query Parameters</h3><ul><li><strong>offset</strong>: <em>(integer - default: 0)</em><p>Skip over a number of elements by specifying an offset value for the query.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>20</code></pre></div></li><li><strong>limit</strong>: <em>(integer - default: 10)</em><p>Limit the number of elements on the response.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>80</code></pre></div></li></ul><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>:</p><pre><code>{
"type": "array",
"$schema": "http://json-schema.org/draft-07/schema",
"id": "http://jsonschema.net",
"items": {
"$ref": "class-retrieve.json"
}
}
</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="classes" class="panel-title">/classes</h3></div><div class="panel-body"><div class="top-resource-description"><p>Collection of all classes, active and inactive.</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_classes"><span class="parent"></span>/classes</a> <span class="methods"><a href="#classes_get"><span class="badge badge_get">get</span></a> <a href="#classes_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_classes" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#classes_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get the pageable and searchable list of all classes, ordered by date.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#classes_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Create a new class.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="classes_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent"></span>/classes</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get the pageable and searchable list of all classes, ordered by date.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#classes_get_request" data-toggle="tab">Request</a></li><li><a href="#classes_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="classes_get_request"><h3>Query Parameters</h3><ul><li><strong>active</strong>: <em>(boolean)</em><p>Specifies whether to filter active classes. If true, filter for active classes; if false, filter for inactive classes; if not specified, do not filter.</p></li><li><strong>institution</strong>: <em>(string)</em><p>Institution for which to filter results. Must match, suggested. Drop down, can type for auto.</p></li><li><strong>searchText</strong>: <em>(string)</em><p>Text to search for in class data. Matches class names.</p></li><li><strong>offset</strong>: <em>(integer - default: 0)</em><p>Skip over a number of elements by specifying an offset value for the query.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>20</code></pre></div></li><li><strong>limit</strong>: <em>(integer - default: 10)</em><p>Limit the number of elements on the response.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>80</code></pre></div></li></ul></div><div class="tab-pane" id="classes_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="classes_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent"></span>/classes</h4></div><div class="modal-body"><div class="alert alert-info"><p>Create a new class.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#classes_post_request" data-toggle="tab">Request</a></li><li><a href="#classes_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="classes_post_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: json</p><p><strong>Content</strong>:</p><pre><code>{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema",
"id": "http://jsonschema.net",
"properties": {
"name": {
"type": "string"
},
"active": {
"type": "boolean"
},
"institution": {
"type": "string"
},
"instructorIds": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
}
},
"required": ["name", "active", "instructorIds"],
"additionalProperties": false
}
</code></pre></div><div class="tab-pane" id="classes_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>:</p><pre><code>{
"$type": "object",
"$schema": "http://json-schema.org/draft-07/schema",
"id": "http://jsonschema.net",
"properties": {
"id": {
"type": "string"
}
},
"additionalProperties": false
}
</code></pre></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_classes__classid_"><span class="parent">/classes</span>/{classId}</a> <span class="methods"><a href="#classes__classid__get"><span class="badge badge_get">get</span></a> <a href="#classes__classid__put"><span class="badge badge_put">put</span></a> <a href="#classes__classid__delete"><span class="badge badge_delete">delete</span></a></span></h4></div><div id="panel_classes__classid_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#classes__classid__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get information about a class.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#classes__classid__put'" class="list-group-item"><span class="badge badge_put">put</span><div class="method_description"><p>Update a class's information.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#classes__classid__delete'" class="list-group-item"><span class="badge badge_delete">delete</span><div class="method_description"><p>Delete a class.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="classes__classid__get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/classes</span>/{classId}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get information about a class.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#classes__classid__get_request" data-toggle="tab">Request</a></li><li><a href="#classes__classid__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="classes__classid__get_request"><h3>URI Parameters</h3><ul><li><strong>classId</strong>: <em><span class="required">required</span>(string)</em></li></ul></div><div class="tab-pane" id="classes__classid__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="classes__classid__put"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put</span> <span class="parent">/classes</span>/{classId}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Update a class's information.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#classes__classid__put_request" data-toggle="tab">Request</a></li></ul><div class="tab-content"><div class="tab-pane active" id="classes__classid__put_request"><h3>URI Parameters</h3><ul><li><strong>classId</strong>: <em><span class="required">required</span>(string)</em></li></ul><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: json</p><p><strong>Content</strong>:</p><pre><code>{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema",
"id": "http://jsonschema.net",
"properties": {
"name": {
"type": "string"
},
"active": {
"type": "boolean"
},
"institution": {
"type": "string"
},
"instructorIds": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
}
},
"required": ["name", "active", "instructorIds"],
"additionalProperties": false
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="classes__classid__delete"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_delete">delete</span> <span class="parent">/classes</span>/{classId}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Delete a class.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#classes__classid__delete_request" data-toggle="tab">Request</a></li></ul><div class="tab-content"><div class="tab-pane active" id="classes__classid__delete_request"><h3>URI Parameters</h3><ul><li><strong>classId</strong>: <em><span class="required">required</span>(string)</em></li></ul></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_classes__classid__active"><span class="parent">/classes/{classId}</span>/active</a> <span class="methods"><a href="#classes__classid__active_get"><span class="badge badge_get">get</span></a> <a href="#classes__classid__active_put"><span class="badge badge_put">put</span></a></span></h4></div><div id="panel_classes__classid__active" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#classes__classid__active_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get whether the class is currently active.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#classes__classid__active_put'" class="list-group-item"><span class="badge badge_put">put</span><div class="method_description"><p>Set a class as active or inactive. Setting as inactive will move the class to "past classes" in all lists of current and past classes, and will disable creating questions or responses. Setting as active will set it back.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="classes__classid__active_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/classes/{classId}</span>/active</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get whether the class is currently active.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#classes__classid__active_get_request" data-toggle="tab">Request</a></li><li><a href="#classes__classid__active_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="classes__classid__active_get_request"><h3>URI Parameters</h3><ul><li><strong>classId</strong>: <em><span class="required">required</span>(string)</em></li></ul></div><div class="tab-pane" id="classes__classid__active_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="classes__classid__active_put"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put</span> <span class="parent">/classes/{classId}</span>/active</h4></div><div class="modal-body"><div class="alert alert-info"><p>Set a class as active or inactive. Setting as inactive will move the class to "past classes" in all lists of current and past classes, and will disable creating questions or responses. Setting as active will set it back.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#classes__classid__active_put_request" data-toggle="tab">Request</a></li></ul><div class="tab-content"><div class="tab-pane active" id="classes__classid__active_put_request"><h3>URI Parameters</h3><ul><li><strong>classId</strong>: <em><span class="required">required</span>(string)</em></li></ul><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>:</p><pre><code>{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema",
"id": "http://jsonschema.net",
"properties": {
"active": {
"type": "boolean"
}
},
"required": ["active"],
"additionalProperties": false
}
</code></pre></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_classes__classid__instructors"><span class="parent">/classes/{classId}</span>/instructors</a> <span class="methods"><a href="#classes__classid__instructors_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_classes__classid__instructors" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#classes__classid__instructors_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get all instructors for a class, ordered alphabetically.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="classes__classid__instructors_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/classes/{classId}</span>/instructors</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get all instructors for a class, ordered alphabetically.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#classes__classid__instructors_get_request" data-toggle="tab">Request</a></li><li><a href="#classes__classid__instructors_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="classes__classid__instructors_get_request"><h3>URI Parameters</h3><ul><li><strong>classId</strong>: <em><span class="required">required</span>(string)</em></li></ul></div><div class="tab-pane" id="classes__classid__instructors_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_classes__classid__instructors__instructorid_"><span class="parent">/classes/{classId}/instructors</span>/{instructorId}</a> <span class="methods"><a href="#classes__classid__instructors__instructorid__put"><span class="badge badge_put">put</span></a> <a href="#classes__classid__instructors__instructorid__delete"><span class="badge badge_delete">delete</span></a></span></h4></div><div id="panel_classes__classid__instructors__instructorid_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#classes__classid__instructors__instructorid__put'" class="list-group-item"><span class="badge badge_put">put</span><div class="method_description"><p>Add a new instructor to this class.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#classes__classid__instructors__instructorid__delete'" class="list-group-item"><span class="badge badge_delete">delete</span><div class="method_description"><p>Remove an instructor from the class. Will respond with 403 Forbidden if this is the last remaining instructor.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="classes__classid__instructors__instructorid__put"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put</span> <span class="parent">/classes/{classId}/instructors</span>/{instructorId}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Add a new instructor to this class.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#classes__classid__instructors__instructorid__put_request" data-toggle="tab">Request</a></li></ul><div class="tab-content"><div class="tab-pane active" id="classes__classid__instructors__instructorid__put_request"><h3>URI Parameters</h3><ul><li><strong>classId</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>instructorId</strong>: <em><span class="required">required</span>(string)</em></li></ul></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="classes__classid__instructors__instructorid__delete"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_delete">delete</span> <span class="parent">/classes/{classId}/instructors</span>/{instructorId}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Remove an instructor from the class. Will respond with 403 Forbidden if this is the last remaining instructor.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#classes__classid__instructors__instructorid__delete_request" data-toggle="tab">Request</a></li></ul><div class="tab-content"><div class="tab-pane active" id="classes__classid__instructors__instructorid__delete_request"><h3>URI Parameters</h3><ul><li><strong>classId</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>instructorId</strong>: <em><span class="required">required</span>(string)</em></li></ul></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_classes__classid__students"><span class="parent">/classes/{classId}</span>/students</a> <span class="methods"><a href="#classes__classid__students_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_classes__classid__students" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#classes__classid__students_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get a pageable list of all students in the class, ordered alphabetically by name.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="classes__classid__students_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/classes/{classId}</span>/students</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get a pageable list of all students in the class, ordered alphabetically by name.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#classes__classid__students_get_request" data-toggle="tab">Request</a></li><li><a href="#classes__classid__students_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="classes__classid__students_get_request"><h3>URI Parameters</h3><ul><li><strong>classId</strong>: <em><span class="required">required</span>(string)</em></li></ul><h3>Query Parameters</h3><ul><li><strong>offset</strong>: <em>(integer - default: 0)</em><p>Skip over a number of elements by specifying an offset value for the query.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>20</code></pre></div></li><li><strong>limit</strong>: <em>(integer - default: 10)</em><p>Limit the number of elements on the response.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>80</code></pre></div></li></ul></div><div class="tab-pane" id="classes__classid__students_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_classes__classid__students__studentid_"><span class="parent">/classes/{classId}/students</span>/{studentId}</a> <span class="methods"><a href="#classes__classid__students__studentid__put"><span class="badge badge_put">put</span></a> <a href="#classes__classid__students__studentid__delete"><span class="badge badge_delete">delete</span></a></span></h4></div><div id="panel_classes__classid__students__studentid_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#classes__classid__students__studentid__put'" class="list-group-item"><span class="badge badge_put">put</span><div class="method_description"><p>Add a student to the class.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#classes__classid__students__studentid__delete'" class="list-group-item"><span class="badge badge_delete">delete</span><div class="method_description"><p>Delete a student from a class</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="classes__classid__students__studentid__put"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put</span> <span class="parent">/classes/{classId}/students</span>/{studentId}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Add a student to the class.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#classes__classid__students__studentid__put_request" data-toggle="tab">Request</a></li></ul><div class="tab-content"><div class="tab-pane active" id="classes__classid__students__studentid__put_request"><h3>URI Parameters</h3><ul><li><strong>classId</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>studentId</strong>: <em><span class="required">required</span>(string)</em></li></ul></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="classes__classid__students__studentid__delete"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_delete">delete</span> <span class="parent">/classes/{classId}/students</span>/{studentId}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Delete a student from a class</p></div><ul class="nav nav-tabs"><li class="active"><a href="#classes__classid__students__studentid__delete_request" data-toggle="tab">Request</a></li></ul><div class="tab-content"><div class="tab-pane active" id="classes__classid__students__studentid__delete_request"><h3>URI Parameters</h3><ul><li><strong>classId</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>studentId</strong>: <em><span class="required">required</span>(string)</em></li></ul></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_classes__classid__students__studentid__performance"><span class="parent">/classes/{classId}/students/{studentId}</span>/performance</a> <span class="methods"><a href="#classes__classid__students__studentid__performance_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_classes__classid__students__studentid__performance" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#classes__classid__students__studentid__performance_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get a student's performance in the class.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="classes__classid__students__studentid__performance_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/classes/{classId}/students/{studentId}</span>/performance</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get a student's performance in the class.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#classes__classid__students__studentid__performance_get_request" data-toggle="tab">Request</a></li><li><a href="#classes__classid__students__studentid__performance_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="classes__classid__students__studentid__performance_get_request"><h3>URI Parameters</h3><ul><li><strong>classId</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>studentId</strong>: <em><span class="required">required</span>(string)</em></li></ul></div><div class="tab-pane" id="classes__classid__students__studentid__performance_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_classes__classid__responses"><span class="parent">/classes/{classId}</span>/responses</a> <span class="methods"><a href="#classes__classid__responses_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_classes__classid__responses" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>A list of all responses to questions in the class.</p></div><div class="list-group"><div onclick="window.location.href = '#classes__classid__responses_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get all the responses for a class</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="classes__classid__responses_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/classes/{classId}</span>/responses</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get all the responses for a class</p></div><ul class="nav nav-tabs"><li class="active"><a href="#classes__classid__responses_get_request" data-toggle="tab">Request</a></li><li><a href="#classes__classid__responses_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="classes__classid__responses_get_request"><h3>URI Parameters</h3><ul><li><strong>classId</strong>: <em><span class="required">required</span>(string)</em></li></ul><h3>Query Parameters</h3><ul><li><strong>offset</strong>: <em>(integer - default: 0)</em><p>Skip over a number of elements by specifying an offset value for the query.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>20</code></pre></div></li><li><strong>limit</strong>: <em>(integer - default: 10)</em><p>Limit the number of elements on the response.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>80</code></pre></div></li><li><strong>orderBy</strong>: <em>(one of recency, correct, incorrect - default: recency)</em><p>Order by field</p></li><li><strong>order</strong>: <em>(one of desc, asc - default: desc)</em><p>Order</p></li><li><strong>query</strong>: <em>(string)</em><p>Query to search for. Searches in question texts, answer texts, and short answer responses.</p></li></ul></div><div class="tab-pane" id="classes__classid__responses_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_classes__classid__questions"><span class="parent">/classes/{classId}</span>/questions</a> <span class="methods"><a href="#classes__classid__questions_get"><span class="badge badge_get">get</span></a> <a href="#classes__classid__questions_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_classes__classid__questions" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>The collection of all questions in the class.</p></div><div class="list-group"><div onclick="window.location.href = '#classes__classid__questions_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get a pageable and searchable list of all questions in the class.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#classes__classid__questions_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Create a question for a class.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="classes__classid__questions_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/classes/{classId}</span>/questions</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get a pageable and searchable list of all questions in the class.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#classes__classid__questions_get_request" data-toggle="tab">Request</a></li><li><a href="#classes__classid__questions_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="classes__classid__questions_get_request"><h3>URI Parameters</h3><ul><li><strong>classId</strong>: <em><span class="required">required</span>(string)</em></li></ul><h3>Query Parameters</h3><ul><li><strong>viewableByStudents</strong>: <em>(boolean)</em><p>Specifies whether to filter for questions viewable by students. Controlled by instructor after asking question. If true, filter for questions marked viewable by students; if false, filter for questions not marked viewable by students; if not present, don't filter at all. (In future) - will return an error if viewableByStudents is not present or false and this request is done by a student account.</p></li><li><strong>offset</strong>: <em>(integer - default: 0)</em><p>Skip over a number of elements by specifying an offset value for the query.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>20</code></pre></div></li><li><strong>limit</strong>: <em>(integer - default: 10)</em><p>Limit the number of elements on the response.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>80</code></pre></div></li><li><strong>query</strong>: <em>(string)</em><p>Query to search for. Searches in question texts and answer texts.</p></li></ul></div><div class="tab-pane" id="classes__classid__questions_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="classes__classid__questions_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/classes/{classId}</span>/questions</h4></div><div class="modal-body"><div class="alert alert-info"><p>Create a question for a class.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#classes__classid__questions_post_request" data-toggle="tab">Request</a></li></ul><div class="tab-content"><div class="tab-pane active" id="classes__classid__questions_post_request"><h3>URI Parameters</h3><ul><li><strong>classId</strong>: <em><span class="required">required</span>(string)</em></li></ul><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: json</p><p><strong>Content</strong>:</p><pre><code>{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema",
"id": "http://jsonschema.net",
"properties": {
"questionText": {
"type": "string"
}
},
"oneOf": [
{
"properties": {
"type": {
"type": "string",
"const": "multiple-choice"
},
"numAnswers": {
"type": "integer",
"minimum": 0
},
"correctAnswer": {
"type": "integer",
"minimum": 0
},
"answerTexts": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["type", "numAnswers"]
},
{
"properties": {
"type": {
"type": "string",
"const": "short-answer"
},
"correctAnswer": {
"type": "string"
}
},
"required": ["type"]
}
],
"additionalProperties": false
}</code></pre></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_classes__classid__questions__questionid_"><span class="parent">/classes/{classId}/questions</span>/{questionId}</a> <span class="methods"><a href="#classes__classid__questions__questionid__get"><span class="badge badge_get">get</span></a> <a href="#classes__classid__questions__questionid__put"><span class="badge badge_put">put</span></a> <a href="#classes__classid__questions__questionid__delete"><span class="badge badge_delete">delete</span></a></span></h4></div><div id="panel_classes__classid__questions__questionid_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#classes__classid__questions__questionid__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get information about a question for a class.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#classes__classid__questions__questionid__put'" class="list-group-item"><span class="badge badge_put">put</span><div class="method_description"><p>Modify a question's information.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#classes__classid__questions__questionid__delete'" class="list-group-item"><span class="badge badge_delete">delete</span><div class="method_description"></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="classes__classid__questions__questionid__get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/classes/{classId}/questions</span>/{questionId}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get information about a question for a class.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#classes__classid__questions__questionid__get_request" data-toggle="tab">Request</a></li><li><a href="#classes__classid__questions__questionid__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="classes__classid__questions__questionid__get_request"><h3>URI Parameters</h3><ul><li><strong>classId</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>questionId</strong>: <em><span class="required">required</span>(string)</em></li></ul></div><div class="tab-pane" id="classes__classid__questions__questionid__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="classes__classid__questions__questionid__put"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put</span> <span class="parent">/classes/{classId}/questions</span>/{questionId}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Modify a question's information.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#classes__classid__questions__questionid__put_request" data-toggle="tab">Request</a></li></ul><div class="tab-content"><div class="tab-pane active" id="classes__classid__questions__questionid__put_request"><h3>URI Parameters</h3><ul><li><strong>classId</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>questionId</strong>: <em><span class="required">required</span>(string)</em></li></ul><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: json</p><p><strong>Content</strong>:</p><pre><code>{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema",
"id": "http://jsonschema.net",
"properties": {
"questionText": {
"type": "string"
}
},
"oneOf": [
{
"properties": {
"type": {
"type": "string",
"const": "multiple-choice"
},
"numAnswers": {
"type": "integer",
"minimum": 0
},
"correctAnswer": {
"type": "integer",
"minimum": 0
},
"answerTexts": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["type", "numAnswers"]
},
{
"properties": {
"type": {
"type": "string",
"const": "short-answer"
},
"correctAnswer": {
"type": "string"
}
},
"required": ["type"]
}
],
"additionalProperties": false
}</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="classes__classid__questions__questionid__delete"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_delete">delete</span> <span class="parent">/classes/{classId}/questions</span>/{questionId}</h4></div><div class="modal-body"><ul class="nav nav-tabs"><li class="active"><a href="#classes__classid__questions__questionid__delete_request" data-toggle="tab">Request</a></li></ul><div class="tab-content"><div class="tab-pane active" id="classes__classid__questions__questionid__delete_request"><h3>URI Parameters</h3><ul><li><strong>classId</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>questionId</strong>: <em><span class="required">required</span>(string)</em></li></ul></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_classes__classid__questions__questionid__viewable_by_students"><span class="parent">/classes/{classId}/questions/{questionId}</span>/viewable-by-students</a> <span class="methods"><a href="#classes__classid__questions__questionid__viewable_by_students_get"><span class="badge badge_get">get</span></a> <a href="#classes__classid__questions__questionid__viewable_by_students_put"><span class="badge badge_put">put</span></a></span></h4></div><div id="panel_classes__classid__questions__questionid__viewable_by_students" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#classes__classid__questions__questionid__viewable_by_students_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get whether a question is viewable by students.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#classes__classid__questions__questionid__viewable_by_students_put'" class="list-group-item"><span class="badge badge_put">put</span><div class="method_description"><p>Set whether a question is viewable by students.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="classes__classid__questions__questionid__viewable_by_students_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/classes/{classId}/questions/{questionId}</span>/viewable-by-students</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get whether a question is viewable by students.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#classes__classid__questions__questionid__viewable_by_students_get_request" data-toggle="tab">Request</a></li><li><a href="#classes__classid__questions__questionid__viewable_by_students_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="classes__classid__questions__questionid__viewable_by_students_get_request"><h3>URI Parameters</h3><ul><li><strong>classId</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>questionId</strong>: <em><span class="required">required</span>(string)</em></li></ul></div><div class="tab-pane" id="classes__classid__questions__questionid__viewable_by_students_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="classes__classid__questions__questionid__viewable_by_students_put"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put</span> <span class="parent">/classes/{classId}/questions/{questionId}</span>/viewable-by-students</h4></div><div class="modal-body"><div class="alert alert-info"><p>Set whether a question is viewable by students.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#classes__classid__questions__questionid__viewable_by_students_put_request" data-toggle="tab">Request</a></li></ul><div class="tab-content"><div class="tab-pane active" id="classes__classid__questions__questionid__viewable_by_students_put_request"><h3>URI Parameters</h3><ul><li><strong>classId</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>questionId</strong>: <em><span class="required">required</span>(string)</em></li></ul><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>:</p><pre><code>{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema",
"id": "http://jsonschema.net",
"properties": {
"viewableByStudents": {
"type": "boolean"
}
},
"required": "viewableByStudents",
"additionalProperties": false
}
</code></pre></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_classes__classid__questions__questionid__responses"><span class="parent">/classes/{classId}/questions/{questionId}</span>/responses</a> <span class="methods"><a href="#classes__classid__questions__questionid__responses_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_classes__classid__questions__questionid__responses" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>A list of all responses to this question.</p></div><div class="list-group"><div onclick="window.location.href = '#classes__classid__questions__questionid__responses_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get the list of all responses to a question.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="classes__classid__questions__questionid__responses_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/classes/{classId}/questions/{questionId}</span>/responses</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get the list of all responses to a question.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#classes__classid__questions__questionid__responses_get_request" data-toggle="tab">Request</a></li><li><a href="#classes__classid__questions__questionid__responses_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="classes__classid__questions__questionid__responses_get_request"><h3>URI Parameters</h3><ul><li><strong>classId</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>questionId</strong>: <em><span class="required">required</span>(string)</em></li></ul><h3>Query Parameters</h3><ul><li><strong>offset</strong>: <em>(integer - default: 0)</em><p>Skip over a number of elements by specifying an offset value for the query.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>20</code></pre></div></li><li><strong>limit</strong>: <em>(integer - default: 10)</em><p>Limit the number of elements on the response.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>80</code></pre></div></li><li><strong>orderBy</strong>: <em>(one of recency, correct, incorrect - default: correct)</em><p>Order by field</p></li><li><strong>order</strong>: <em>(one of desc, asc - default: desc)</em><p>Order</p></li></ul></div><div class="tab-pane" id="classes__classid__questions__questionid__responses_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_classes__classid__questions__questionid__responses__studentid_"><span class="parent">/classes/{classId}/questions/{questionId}/responses</span>/{studentId}</a> <span class="methods"><a href="#classes__classid__questions__questionid__responses__studentid__get"><span class="badge badge_get">get</span></a> <a href="#classes__classid__questions__questionid__responses__studentid__put"><span class="badge badge_put">put</span></a> <a href="#classes__classid__questions__questionid__responses__studentid__delete"><span class="badge badge_delete">delete</span></a></span></h4></div><div id="panel_classes__classid__questions__questionid__responses__studentid_" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>The response by a specific student to this question.</p></div><div class="list-group"><div onclick="window.location.href = '#classes__classid__questions__questionid__responses__studentid__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get the response made by a student to this question.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#classes__classid__questions__questionid__responses__studentid__put'" class="list-group-item"><span class="badge badge_put">put</span><div class="method_description"><p>Create or change a student's response to this question</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#classes__classid__questions__questionid__responses__studentid__delete'" class="list-group-item"><span class="badge badge_delete">delete</span><div class="method_description"><p>Delete a student's reponse to this question.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="classes__classid__questions__questionid__responses__studentid__get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/classes/{classId}/questions/{questionId}/responses</span>/{studentId}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get the response made by a student to this question.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#classes__classid__questions__questionid__responses__studentid__get_request" data-toggle="tab">Request</a></li><li><a href="#classes__classid__questions__questionid__responses__studentid__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="classes__classid__questions__questionid__responses__studentid__get_request"><h3>URI Parameters</h3><ul><li><strong>classId</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>questionId</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>studentId</strong>: <em><span class="required">required</span>(string)</em></li></ul></div><div class="tab-pane" id="classes__classid__questions__questionid__responses__studentid__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a></h2></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="classes__classid__questions__questionid__responses__studentid__put"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put</span> <span class="parent">/classes/{classId}/questions/{questionId}/responses</span>/{studentId}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Create or change a student's response to this question</p></div><ul class="nav nav-tabs"><li class="active"><a href="#classes__classid__questions__questionid__responses__studentid__put_request" data-toggle="tab">Request</a></li></ul><div class="tab-content"><div class="tab-pane active" id="classes__classid__questions__questionid__responses__studentid__put_request"><h3>URI Parameters</h3><ul><li><strong>classId</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>questionId</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>studentId</strong>: <em><span class="required">required</span>(string)</em></li></ul><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: json</p><p><strong>Content</strong>:</p><pre><code>{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema",
"id" : "http://jsonschema.net",
"properties": {
"timestamp": {
"type": "string",
"format": "date-time"
}
},
"oneOf": [
{
"properties": {
"answerNumber": {
"type": "integer",
"minimum": 0
}
}
},
{
"properties": {
"answerText": {
"type": "string"
}
}
}
]
}</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="classes__classid__questions__questionid__responses__studentid__delete"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_delete">delete</span> <span class="parent">/classes/{classId}/questions/{questionId}/responses</span>/{studentId}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Delete a student's reponse to this question.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#classes__classid__questions__questionid__responses__studentid__delete_request" data-toggle="tab">Request</a></li></ul><div class="tab-content"><div class="tab-pane active" id="classes__classid__questions__questionid__responses__studentid__delete_request"><h3>URI Parameters</h3><ul><li><strong>classId</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>questionId</strong>: <em><span class="required">required</span>(string)</em></li><li><strong>studentId</strong>: <em><span class="required">required</span>(string)</em></li></ul></div></div></div></div></div></div></div></div></div></div></div><div class="col-md-3"><div id="sidebar" class="hidden-print affix" role="complementary"><ul class="nav nav-pills nav-stacked"><li><a href="#students">/students</a></li><li><a href="#instructors">/instructors</a></li><li><a href="#classes">/classes</a></li></ul></div></div></div></div></body></html>