-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdocs.html
More file actions
794 lines (792 loc) · 47.6 KB
/
docs.html
File metadata and controls
794 lines (792 loc) · 47.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<link rel="icon" href="/favicon.svg?" type="image/svg+xml">
<link rel="stylesheet" type="text/css" href="docs.css">
</head>
<body>
<h1 id="jupiterp-api-v0-docs-pre-release-">Jupiterp API v0 Docs (pre-release)</h1>
<h2 id="introduction">Introduction</h2>
<p>Welcome to the Jupiterp API, a free and open-source API to get detailed course data for the University of Maryland. Currently, the API is in pre-release phase and is unstable; expect breaking changes, but the information in these docs should be correct and up-to-date.</p>
<p>For any questions or bugs, please contact <a href="mailto:admin@jupiterp.com">admin@jupiterp.com</a>.</p>
<p>Feel free to view or contribute to the project <a href="https://www.github.com/jupiterp-umd/api">on GitHub</a>.</p>
<h2 id="endpoints">Endpoints</h2>
<table>
<thead>
<tr>
<th style="text-align:left">path</th>
<th style="text-align:left">description</th>
<th style="text-align:left">link</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><code>/v0/</code></td>
<td style="text-align:left">Base endpoint</td>
<td style="text-align:left"><a href="#-v0-">jump</a></td>
</tr>
<tr>
<td style="text-align:left"><code>/v0/courses</code></td>
<td style="text-align:left">Get a list of courses with full course info</td>
<td style="text-align:left"><a href="#-v0-courses-">jump</a></td>
</tr>
<tr>
<td style="text-align:left"><code>/v0/courses/minified</code></td>
<td style="text-align:left">Get a list of courses with just the code and title for each</td>
<td style="text-align:left"><a href="#-v0-courses-minified-">jump</a></td>
</tr>
<tr>
<td style="text-align:left"><code>/v0/courses/withSections</code></td>
<td style="text-align:left">Get a list of courses, including section data for each course</td>
<td style="text-align:left"><a href="#-v0-courses-withsections-">jump</a></td>
</tr>
<tr>
<td style="text-align:left"><code>/v0/sections</code></td>
<td style="text-align:left">Get a list of sections for courses</td>
<td style="text-align:left"><a href="#-v0-sections-">jump</a></td>
</tr>
<tr>
<td style="text-align:left"><code>/v0/instructors</code></td>
<td style="text-align:left">Get a list of instructors and their ratings</td>
<td style="text-align:left"><a href="#-v0-instructors-">jump</a></td>
</tr>
<tr>
<td style="text-align:left"><code>/v0/instructors/active</code></td>
<td style="text-align:left">Get a list of instructors actively teaching a course</td>
<td style="text-align:left"><a href="#-v0-instructors-active-">jump</a></td>
</tr>
<tr>
<td style="text-align:left"><code>/v0/deptList</code></td>
<td style="text-align:left">Get a list of 4-letter department codes</td>
<td style="text-align:left"><a href="#-v0-deptlist-">jump</a></td>
</tr>
</tbody>
</table>
<h3 id="-v0-"><code>/v0/</code></h3>
<p><a href="#endpoints">(back to endpoints)</a></p>
<p>This is the base endpoint for v0 of the Jupiterp API. It will simply return a HTTP StatusOK with some text to indicate that the Jupiterp API is online.</p>
<h3 id="-v0-courses-"><code>/v0/courses</code></h3>
<p><a href="#endpoints">(back to endpoints)</a></p>
<p>Gets a list of courses that match the given query parameters. This endpoint does not return section information; for section info, use the <code>sections</code> endpoint listed below.</p>
<h4 id="query-parameters">Query parameters</h4>
<table>
<thead>
<tr>
<th style="text-align:left">param</th>
<th style="text-align:left">description</th>
<th style="text-align:left">example</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><code>courseCodes</code> (optional)</td>
<td style="text-align:left">A string of one or multiple comma-separated course codes to fetch course data for; cannot set both <code>courseCodes</code> and <code>prefix</code>.</td>
<td style="text-align:left"><code>courseCodes=CMSC132,MATH141</code></td>
</tr>
<tr>
<td style="text-align:left"><code>prefix</code> (optional)</td>
<td style="text-align:left">The course prefix to match records to; for instance, <code>CMSC1</code> would match all CMSC1XX courses (like CMSC131 and CMSC132); cannot set both <code>courseCodes</code> and <code>prefix</code>.</td>
<td style="text-align:left"><code>prefix=CMSC1</code></td>
</tr>
<tr>
<td style="text-align:left"><code>number</code> (optional)</td>
<td style="text-align:left">The course number to search for across multiple departments; for instance, <code>433</code> would match to courses like AOSC433, AREC433, etc.</td>
<td style="text-align:left"><code>number=433</code></td>
</tr>
<tr>
<td style="text-align:left"><code>genEds</code> (optional)</td>
<td style="text-align:left">A string of one or multiple comma-separated Gen-Eds to filter for; if multiple Gen-Eds are included, the API will return courses that satisfy all listed Gen-Eds.</td>
<td style="text-align:left"><code>genEds=DVUP,DSSP</code></td>
</tr>
<tr>
<td style="text-align:left"><code>credits</code> (optional)</td>
<td style="text-align:left">A string of equalities/inequalities to filter courses by how many credits they have. For courses with a range of possible credit values, filters by the minimum number of credits. Possible equality/inequality expressions are: <code>eq</code>, <code>lte</code>, <code>lt</code>, <code>gt</code>, <code>gte</code>, <code>neq</code> (for equal to, less than or equal to, less than, etc.). For multiple conditions, use multiple <code>credits</code> arguments.</td>
<td style="text-align:left"><code>credits=gt.1&credits=lt.5</code></td>
</tr>
<tr>
<td style="text-align:left"><code>limit</code> (optional)</td>
<td style="text-align:left">Maximum number of course records to return; defaults to 100, maximum of 500.</td>
<td style="text-align:left"><code>limit=10</code></td>
</tr>
<tr>
<td style="text-align:left"><code>offset</code> (optional)</td>
<td style="text-align:left">How many records to skip when returning courses; defaults to 0</td>
<td style="text-align:left"><code>offset=10</code></td>
</tr>
<tr>
<td style="text-align:left"><code>sortBy</code> (optional)</td>
<td style="text-align:left">A comma-separated list of which columns to sort by when returning; can be sorted in ascending (<code>.asc</code>) or descending (<code>.desc</code>) order.</td>
<td style="text-align:left"><code>sortBy=name.asc,min_credits.desc</code></td>
</tr>
</tbody>
</table>
<h4 id="output">Output</h4>
<table>
<thead>
<tr>
<th style="text-align:left">field</th>
<th style="text-align:center">type</th>
<th style="text-align:left">description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><code>course_code</code></td>
<td style="text-align:center">string</td>
<td style="text-align:left">The unique course code for a course, which consists of a four-letter department code, a three digit course identifier, and optional letters at the end.</td>
</tr>
<tr>
<td style="text-align:left"><code>name</code></td>
<td style="text-align:center">string</td>
<td style="text-align:left">The name of a course, providing very brief information about the subject of the course.</td>
</tr>
<tr>
<td style="text-align:left"><code>min_credits</code></td>
<td style="text-align:center">int</td>
<td style="text-align:left">The minimum number of credits this course is worth. For courses that do not have a range of possible credit values, this field is simply the number of credits the course is worth. All courses have a non-null <code>min_credits</code> field.</td>
</tr>
<tr>
<td style="text-align:left"><code>max_credits</code></td>
<td style="text-align:center">int or null</td>
<td style="text-align:left">The maximum number of credits a course is worth, if the course has a range of possible credit values. For courses that have a set credit value, this field will be null.</td>
</tr>
<tr>
<td style="text-align:left"><code>gen_eds</code></td>
<td style="text-align:center">string[] or null</td>
<td style="text-align:left">A list of four-letter codes for the Gen-Ed requirements this course satisfies (ex. DSSP, DVUP).</td>
</tr>
<tr>
<td style="text-align:left"><code>conditions</code></td>
<td style="text-align:center">string[] or null</td>
<td style="text-align:left">A list of additionall conditions listed for this course. This consists of things like prerequisites, corequisites, or additional information.</td>
</tr>
<tr>
<td style="text-align:left"><code>description</code></td>
<td style="text-align:center">string or null</td>
<td style="text-align:left">A detailed description of the course. Some courses do not have a description, especially independent research courses.</td>
</tr>
</tbody>
</table>
<h4 id="examples">Examples</h4>
<h5 id="getting-multiple-specific-courses">Getting multiple specific courses</h5>
<p>Request: <code>GET http://api.jupiterp.com/v0/courses?courseCodes=CMSC131,MATH141</code></p>
<p>Response:</p>
<pre><code>[
{
<span class="hljs-string">"course_code"</span>: <span class="hljs-string">"CMSC131"</span>,
<span class="hljs-string">"name"</span>: <span class="hljs-string">"Object-Oriented Programming I"</span>,
<span class="hljs-string">"min_credits"</span>: <span class="hljs-number">4</span>,
<span class="hljs-string">"max_credits"</span>: null,
<span class="hljs-string">"gen_eds"</span>: null,
<span class="hljs-string">"conditions"</span>: [
<span class="hljs-string">"Corequisite: MATH140. "</span>,
<span class="hljs-string">"Credit only granted for: CMSC131, CMSC133 or CMSC141."</span>
],
<span class="hljs-string">"description"</span>: <span class="hljs-comment">"Introduction to programming and computer science.</span>
Emphasizes understanding <span class="hljs-built_in">and</span> implementation of applications using
object-oriented techniques. Develops skills such <span class="hljs-keyword">as</span> program design <span class="hljs-built_in">and</span>
testing <span class="hljs-keyword">as</span> well <span class="hljs-keyword">as</span> implementation of programs using <span class="hljs-keyword">a</span> graphical IDE.
Programming done in Java.<span class="hljs-comment">"</span>
},
{
<span class="hljs-string">"course_code"</span>: <span class="hljs-string">"MATH141"</span>,
<span class="hljs-string">"name"</span>: <span class="hljs-string">"Calculus II"</span>,
<span class="hljs-string">"min_credits"</span>: <span class="hljs-number">4</span>,
<span class="hljs-string">"max_credits"</span>: null,
<span class="hljs-string">"gen_eds"</span>: null,
<span class="hljs-string">"conditions"</span>: [
<span class="hljs-string">"Prerequisite: Minimum grade of C- in MATH140."</span>
],
<span class="hljs-string">"description"</span>: <span class="hljs-comment">"Continuation of MATH140, including techniques of</span>
integration, improper integrals, applications of integration (such <span class="hljs-keyword">as</span>
volumes, work, arc length, moments), inverse functions, exponential <span class="hljs-built_in">and</span>
logarithmic functions, sequences <span class="hljs-built_in">and</span> series.<span class="hljs-comment">"</span>
}
]
</code></pre><h5 id="getting-courses-that-satisfy-gen-ed-requirements">Getting courses that satisfy Gen-Ed requirements</h5>
<p>Request: <code>GET http://api.jupiterp.com/v0/courses?genEds=DVUP,DSSP&limit=2&sortBy=courseCode.asc</code></p>
<p>Response:</p>
<pre><code>[
{
<span class="hljs-comment">"course_code"</span>: <span class="hljs-comment">"AAST351"</span>,
<span class="hljs-comment">"name"</span>: <span class="hljs-comment">"Asian Americans and Media"</span>,
<span class="hljs-comment">"min_credits"</span>: <span class="hljs-number">3</span>,
<span class="hljs-comment">"max_credits"</span>: null,
<span class="hljs-comment">"gen_eds"</span>: [
<span class="hljs-comment">"DSSP"</span>,
<span class="hljs-comment">"DVUP"</span>
],
<span class="hljs-comment">"conditions"</span>: [
<span class="hljs-comment">"Credit only granted for: AAST351, AAST398M or AAST398N. "</span>,
<span class="hljs-comment">"Formerly: AAST398M, AAST398N."</span>
],
<span class="hljs-comment">"description"</span>: <span class="hljs-comment">"From yellow peril invaders to model minority allies, Asian
Americans have crafted their own dynamic cultural expressions in a number
of media from film, television, and music to fashion, sports, and food that
reveal and contest the contradictions of the U.S. nation-state. Asian
American culture also uniquely sits at the nexus of immigration flows and
digital technologies, providing a transnational lens to view the US place
in the world. This advanced course, then, will introduce students to the
study and practice of Asian American culture as multiple , hybrid, and
heterogeneous. It will do so through three sections: section one will
introduce students to classical, cultural, and media concepts as well as
relevant keywords outlined by Asian American Studies scholars; section two
will review the work of Asian American cultural theorists; section three
will focus on analyses of particular Asian American cultural productions.
In doing so, students will gain an understanding of the shifting and
interlocking tensions among the local, the national, and the global that
form the cultural geographies of Asian America."</span>
},
{
<span class="hljs-comment">"course_code"</span>: <span class="hljs-comment">"AMST320"</span>,
<span class="hljs-comment">"name"</span>: <span class="hljs-comment">"(Dis)ability in American Film"</span>,
<span class="hljs-comment">"min_credits"</span>: <span class="hljs-number">3</span>,
<span class="hljs-comment">"max_credits"</span>: null,
<span class="hljs-comment">"gen_eds"</span>: [
<span class="hljs-comment">"DSHU"</span>,
<span class="hljs-comment">"DSSP"</span>,
<span class="hljs-comment">"DVUP"</span>
],
<span class="hljs-comment">"conditions"</span>: [
<span class="hljs-comment">"Credit only granted for: AMST320 or AMST328X. "</span>,
<span class="hljs-comment">"Formerly: AMST328X."</span>
],
<span class="hljs-comment">"description"</span>: <span class="hljs-comment">"Explores the connection between film and disability
through an analysis of independent and mainstream American films in various
film genres. Specifically, we will consider how these film representations
reflect and/or challenge the shifting social perspectives of disability
over the 20th and 21st centuries. Beginning with the presentation of
disability as theatrical spectacle in the traveling sideshow and early
cinema, we will work our way through film history to develop an
understanding of our society's complicated relationship with disability."</span>
}
]
</code></pre><h3 id="-v0-courses-minified-"><code>/v0/courses/minified</code></h3>
<p><a href="#endpoints">(back to endpoints)</a></p>
<p>Gets a minified list of courses that satisfy the given parameters. Takes the same parameters as the <code>/v0/courses</code> endpoint, but returns only the course code and title.</p>
<h4 id="query-parameters">Query parameters</h4>
<p>Same as the parameters for <code>/v0/courses</code>; see <a href="#-v0-courses-">here</a>.</p>
<h4 id="output">Output</h4>
<table>
<thead>
<tr>
<th style="text-align:left">field</th>
<th style="text-align:center">type</th>
<th style="text-align:left">description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><code>course_code</code></td>
<td style="text-align:center">string</td>
<td style="text-align:left">The unique course code for a course, which consists of a four-letter department code, a three digit course identifier, and optional letters at the end.</td>
</tr>
<tr>
<td style="text-align:left"><code>name</code></td>
<td style="text-align:center">string</td>
<td style="text-align:left">The name of a course, providing very brief information about the subject of the course.</td>
</tr>
</tbody>
</table>
<h4 id="examples">Examples</h4>
<h5 id="getting-courses-with-a-specific-prefix">Getting courses with a specific prefix</h5>
<p>Request: <code>GET http://api.jupiterp.com/v0/courses/minified?prefix=ASTR4&sortBy=name.asc</code></p>
<p>Response:</p>
<pre><code>[
{
<span class="hljs-attr">"course_code"</span>: <span class="hljs-string">"ASTR422"</span>,
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Cosmology"</span>
},
{
<span class="hljs-attr">"course_code"</span>: <span class="hljs-string">"ASTR421"</span>,
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Galaxies"</span>
},
{
<span class="hljs-attr">"course_code"</span>: <span class="hljs-string">"ASTR498"</span>,
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Special Problems in Astronomy"</span>
}
]
</code></pre><h3 id="-v0-courses-withsections-"><code>/v0/courses/withSections</code></h3>
<p><a href="#endpoints">(back to endpoints)</a></p>
<p>Gets a list of full courses data and associated sections data. Each returned course also contains a (potentially-empty) list of sections for that course.</p>
<h4 id="query-parameters">Query parameters</h4>
<table>
<thead>
<tr>
<th style="text-align:left">param</th>
<th style="text-align:left">description</th>
<th style="text-align:left">example</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><code>courseCodes</code> (optional)</td>
<td style="text-align:left">A string of one or multiple comma-separated course codes to fetch course data for; cannot set both <code>courseCodes</code> and <code>prefix</code>.</td>
<td style="text-align:left"><code>courseCodes=CMSC132,MATH141</code></td>
</tr>
<tr>
<td style="text-align:left"><code>prefix</code> (optional)</td>
<td style="text-align:left">The course prefix to match records to; for instance, <code>CMSC1</code> would match all CMSC1XX courses (like CMSC131 and CMSC132); cannot set both <code>courseCodes</code> and <code>prefix</code>.</td>
<td style="text-align:left"><code>prefix=CMSC1</code></td>
</tr>
<tr>
<td style="text-align:left"><code>number</code> (optional)</td>
<td style="text-align:left">The course number to search for across multiple departments; for instance, <code>433</code> would match to courses like AOSC433, AREC433, etc.</td>
<td style="text-align:left"><code>number=433</code></td>
</tr>
<tr>
<td style="text-align:left"><code>genEds</code> (optional)</td>
<td style="text-align:left">A string of one or multiple comma-separated Gen-Eds to filter for; if multiple Gen-Eds are included, the API will return courses that satisfy all listed Gen-Eds.</td>
<td style="text-align:left"><code>genEds=DVUP,DSSP</code></td>
</tr>
<tr>
<td style="text-align:left"><code>credits</code> (optional)</td>
<td style="text-align:left">A string of equalities/inequalities to filter courses by how many credits they have. For courses with a range of possible credit values, filters by the minimum number of credits. Possible equality/inequality expressions are: <code>eq</code>, <code>lte</code>, <code>lt</code>, <code>gt</code>, <code>gte</code>, <code>neq</code> (for equal to, less than or equal to, less than, etc.). For multiple conditions, use multiple <code>credits</code> arguments.</td>
<td style="text-align:left"><code>credits=gt.1&credits=lt.5</code></td>
</tr>
<tr>
<td style="text-align:left"><code>totalClassSize</code> (optional)</td>
<td style="text-align:left">A string of equalities/inequalities to filter by the total number of seats in a section. Possible expressions are: <code>eq</code>, <code>lte</code>, <code>lt</code>, <code>gt</code>, <code>gte</code>, <code>neq</code> (for equal to, less than or equal to, less than, etc.). For multiple conditions, use multiple <code>totalClassSize</code> arguments.</td>
<td style="text-align:left"><code>totalClassSize=gt.40&totalClassSize=le.50</code></td>
</tr>
<tr>
<td style="text-align:left"><code>onlyOpen</code> (optional)</td>
<td style="text-align:left">If set to true, only returns sections with more than zero open seats.</td>
<td style="text-align:left"><code>onlyOpen=true</code></td>
</tr>
<tr>
<td style="text-align:left"><code>instructor</code> (optional)</td>
<td style="text-align:left">Return only sections that have the given instructor in the <code>instructors</code> field. This field is case-sensitive.</td>
<td style="text-align:left"><code>instructor=Darryll%20Pines</code></td>
</tr>
<tr>
<td style="text-align:left"><code>limit</code> (optional)</td>
<td style="text-align:left">Maximum number of course records to return; defaults to 100, maximum of 500.</td>
<td style="text-align:left"><code>limit=10</code></td>
</tr>
<tr>
<td style="text-align:left"><code>offset</code> (optional)</td>
<td style="text-align:left">How many records to skip when returning courses; defaults to 0</td>
<td style="text-align:left"><code>offset=10</code></td>
</tr>
<tr>
<td style="text-align:left"><code>sortBy</code> (optional)</td>
<td style="text-align:left">A comma-separated list of which columns to sort by when returning; can be sorted in ascending (<code>.asc</code>) or descending (<code>.desc</code>) order.</td>
<td style="text-align:left"><code>sortBy=name.asc,min_credits.desc</code></td>
</tr>
</tbody>
</table>
<h4 id="output">Output</h4>
<table>
<thead>
<tr>
<th style="text-align:left">field</th>
<th style="text-align:center">type</th>
<th style="text-align:left">description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><code>course_code</code></td>
<td style="text-align:center">string</td>
<td style="text-align:left">The unique course code for a course, which consists of a four-letter department code, a three digit course identifier, and optional letters at the end.</td>
</tr>
<tr>
<td style="text-align:left"><code>name</code></td>
<td style="text-align:center">string</td>
<td style="text-align:left">The name of a course, providing very brief information about the subject of the course.</td>
</tr>
<tr>
<td style="text-align:left"><code>min_credits</code></td>
<td style="text-align:center">int</td>
<td style="text-align:left">The minimum number of credits this course is worth. For courses that do not have a range of possible credit values, this field is simply the number of credits the course is worth. All courses have a non-null <code>min_credits</code> field.</td>
</tr>
<tr>
<td style="text-align:left"><code>max_credits</code></td>
<td style="text-align:center">int or null</td>
<td style="text-align:left">The maximum number of credits a course is worth, if the course has a range of possible credit values. For courses that have a set credit value, this field will be null.</td>
</tr>
<tr>
<td style="text-align:left"><code>gen_eds</code></td>
<td style="text-align:center">string[] or null</td>
<td style="text-align:left">A list of four-letter codes for the Gen-Ed requirements this course satisfies (ex. DSSP, DVUP).</td>
</tr>
<tr>
<td style="text-align:left"><code>conditions</code></td>
<td style="text-align:center">string[] or null</td>
<td style="text-align:left">A list of additionall conditions listed for this course. This consists of things like prerequisites, corequisites, or additional information.</td>
</tr>
<tr>
<td style="text-align:left"><code>description</code></td>
<td style="text-align:center">string or null</td>
<td style="text-align:left">A detailed description of the course. Some courses do not have a description, especially independent research courses.</td>
</tr>
<tr>
<td style="text-align:left"><code>sections</code></td>
<td style="text-align:center">Section[]</td>
<td style="text-align:left">A list of <code>Section</code>s. A <code>Section</code> consists of the fields described in the output of <code>/v0/sections</code> (see <a href="#-v0-sections-">here</a>)</td>
</tr>
</tbody>
</table>
<h4 id="examples">Examples</h4>
<h5 id="getting-a-course-with-sections-data">Getting a course with sections data</h5>
<p>Request: <code>GET http://api.jupiterp.com/v0/courses/withSections?courseCodes=CMSC433</code></p>
<p>Response:</p>
<pre><code>[
{
<span class="hljs-string">"course_code"</span>: <span class="hljs-string">"CMSC433"</span>,
<span class="hljs-string">"name"</span>: <span class="hljs-string">"Programming Language Technologies and Paradigms"</span>,
<span class="hljs-string">"min_credits"</span>: <span class="hljs-number">3</span>,
<span class="hljs-string">"max_credits"</span>: null,
<span class="hljs-string">"gen_eds"</span>: null,
<span class="hljs-string">"conditions"</span>: [
<span class="hljs-string">"Prerequisite: Minimum grade of C- in CMSC330; or must be in the
(Computer Science (Doctoral), Computer Science (Master's)) program. "</span>,
<span class="hljs-string">"Restriction: Permission of CMNS-Computer Science department."</span>
],
<span class="hljs-string">"description"</span>: <span class="hljs-string">"Programming language technologies (e.g., object-oriented
programming), their implementations and use in software design and
implementation."</span>,
<span class="hljs-string">"sections"</span>: [
{
<span class="hljs-string">"holdfile"</span>: <span class="hljs-number">0</span>,
<span class="hljs-string">"meetings"</span>: [
<span class="hljs-string">"TuTh-11:00am-12:15pm-CSI-1115"</span>
],
<span class="hljs-string">"sec_code"</span>: <span class="hljs-string">"0101"</span>,
<span class="hljs-string">"waitlist"</span>: <span class="hljs-number">3</span>,
<span class="hljs-string">"open_seats"</span>: <span class="hljs-number">0</span>,
<span class="hljs-string">"course_code"</span>: <span class="hljs-string">"CMSC433"</span>,
<span class="hljs-string">"instructors"</span>: [
<span class="hljs-string">"Anwar Mamat"</span>
],
<span class="hljs-string">"total_seats"</span>: <span class="hljs-number">140</span>
},
{
<span class="hljs-string">"holdfile"</span>: null,
<span class="hljs-string">"meetings"</span>: [
<span class="hljs-string">"TuTh-3:30pm-4:45pm-IRB-0318"</span>
],
<span class="hljs-string">"sec_code"</span>: <span class="hljs-string">"0201"</span>,
<span class="hljs-string">"waitlist"</span>: <span class="hljs-number">0</span>,
<span class="hljs-string">"open_seats"</span>: <span class="hljs-number">7</span>,
<span class="hljs-string">"course_code"</span>: <span class="hljs-string">"CMSC433"</span>,
<span class="hljs-string">"instructors"</span>: [
<span class="hljs-string">"Anwar Mamat"</span>
],
<span class="hljs-string">"total_seats"</span>: <span class="hljs-number">50</span>
}
]
}
]
</code></pre><h3 id="-v0-sections-"><code>/v0/sections</code></h3>
<p><a href="#endpoints">(back to endpoints)</a></p>
<p>Get sections for specific courses, or for all courses that match a course code prefix. Note that some courses don't have any sections; for example, most independent research courses, like ASTR498, will not return any sections.</p>
<h4 id="query-parameters">Query parameters</h4>
<table>
<thead>
<tr>
<th style="text-align:left">param</th>
<th style="text-align:left">description</th>
<th style="text-align:left">example</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><code>courseCodes</code> (optional)</td>
<td style="text-align:left">A string of one or multiple comma-separated course codes to fetch course data for; cannot set both <code>courseCodes</code> and <code>prefix</code>.</td>
<td style="text-align:left"><code>courseCodes=CMSC132,MATH141</code></td>
</tr>
<tr>
<td style="text-align:left"><code>prefix</code> (optional)</td>
<td style="text-align:left">The course prefix to match records to; for instance, <code>CMSC1</code> would match all CMSC1XX courses (like CMSC131 and CMSC132); cannot set both <code>courseCodes</code> and <code>prefix</code>.</td>
<td style="text-align:left"><code>prefix=CMSC1</code></td>
</tr>
<tr>
<td style="text-align:left"><code>totalClassSize</code> (optional)</td>
<td style="text-align:left">A string of equalities/inequalities to filter by the total number of seats in a section. Possible expressions are: <code>eq</code>, <code>lte</code>, <code>lt</code>, <code>gt</code>, <code>gte</code>, <code>neq</code> (for equal to, less than or equal to, less than, etc.). For multiple conditions, use multiple <code>totalClassSize</code> arguments.</td>
<td style="text-align:left"><code>totalClassSize=gt.40&totalClassSize=le.50</code></td>
</tr>
<tr>
<td style="text-align:left"><code>onlyOpen</code> (optional)</td>
<td style="text-align:left">If set to true, only returns sections with more than zero open seats.</td>
<td style="text-align:left"><code>onlyOpen=true</code></td>
</tr>
<tr>
<td style="text-align:left"><code>instructor</code> (optional)</td>
<td style="text-align:left">Return only sections that have the given instructor in the <code>instructors</code> field. This field is case-sensitive.</td>
<td style="text-align:left"><code>instructor=Darryll%20Pines</code></td>
</tr>
<tr>
<td style="text-align:left"><code>limit</code> (optional)</td>
<td style="text-align:left">Maximum number of course records to return; defaults to 100, maximum of 500.</td>
<td style="text-align:left"><code>limit=10</code></td>
</tr>
<tr>
<td style="text-align:left"><code>offset</code> (optional)</td>
<td style="text-align:left">How many records to skip when returning courses; defaults to 0</td>
<td style="text-align:left"><code>offset=10</code></td>
</tr>
<tr>
<td style="text-align:left"><code>sortBy</code> (optional)</td>
<td style="text-align:left">A comma-separated list of which columns to sort by when returning; can be sorted in ascending (<code>.asc</code>) or descending (<code>.desc</code>) order.</td>
<td style="text-align:left"><code>sortBy=name.asc,min_credits.desc</code></td>
</tr>
</tbody>
</table>
<h4 id="output">Output</h4>
<table>
<thead>
<tr>
<th style="text-align:left">field</th>
<th style="text-align:center">type</th>
<th style="text-align:left">description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><code>course_code</code></td>
<td style="text-align:center">string</td>
<td style="text-align:left">The unique course code for a course, which consists of a four-letter department code, a three digit course identifier, and optional letters at the end.</td>
</tr>
<tr>
<td style="text-align:left"><code>sec_code</code></td>
<td style="text-align:center">string</td>
<td style="text-align:left">The code (usually 4 numbers, but sometimes includes letters) for a section. The <code>sec_code</code> is unique within a given course, but a section may have the same <code>sec_code</code> as a section with a different <code>course_code</code>.</td>
</tr>
<tr>
<td style="text-align:left"><code>instructors</code></td>
<td style="text-align:center">string[]</td>
<td style="text-align:left">A list of the names of instructors teaching a course. Instructor may not be an actual name; for instance, it could be "Instructor: TBA".</td>
</tr>
<tr>
<td style="text-align:left"><code>meetings</code></td>
<td style="text-align:center">string[]</td>
<td style="text-align:left">A list of meeting times and places for the section. Meeting strings have different formats depending on the class format: <ul><li>In-person, synchronous: "Days-StartTime-EndTime-Building-Room"</li><li>Online, synchronous: "Days-StartTime-EndTime-OnlineSync"</li><li>Online, asynchronous: "OnlineAsync"</li><li>Unspecified: "Unspecified"</li></ul> Some courses can have both synchronous and asynchronous meetings.</td>
</tr>
<tr>
<td style="text-align:left"><code>open_seats</code></td>
<td style="text-align:center">int</td>
<td style="text-align:left">The number of available seats for this section.</td>
</tr>
<tr>
<td style="text-align:left"><code>total_seats</code></td>
<td style="text-align:center">int</td>
<td style="text-align:left">The total number of seats in this section.</td>
</tr>
<tr>
<td style="text-align:left"><code>waitlist</code></td>
<td style="text-align:center">int</td>
<td style="text-align:left">How many people are on the waitlist for this section.</td>
</tr>
<tr>
<td style="text-align:left"><code>holdfile</code></td>
<td style="text-align:center">int or null</td>
<td style="text-align:left">The number of people on the holdfile for this section, if a holdfile exists.</td>
</tr>
</tbody>
</table>
<h4 id="examples">Examples</h4>
<h5 id="getting-all-sections-for-a-course">Getting all sections for a course</h5>
<p>Request: <code>GET http://api.jupiterp.com/v0/sections?courseCodes=CMSC433</code></p>
<p>Response:</p>
<pre><code>[
{
<span class="hljs-attr">"course_code"</span>: <span class="hljs-string">"CMSC433"</span>,
<span class="hljs-attr">"sec_code"</span>: <span class="hljs-string">"0101"</span>,
<span class="hljs-attr">"instructors"</span>: [
<span class="hljs-string">"Anwar Mamat"</span>
],
<span class="hljs-attr">"meetings"</span>: [
<span class="hljs-string">"TuTh-11:00am-12:15pm-CSI-1115"</span>
],
<span class="hljs-attr">"open_seats"</span>: <span class="hljs-number">0</span>,
<span class="hljs-attr">"total_seats"</span>: <span class="hljs-number">140</span>,
<span class="hljs-attr">"waitlist"</span>: <span class="hljs-number">7</span>,
<span class="hljs-attr">"holdfile"</span>: <span class="hljs-number">0</span>
},
{
<span class="hljs-attr">"course_code"</span>: <span class="hljs-string">"CMSC433"</span>,
<span class="hljs-attr">"sec_code"</span>: <span class="hljs-string">"0201"</span>,
<span class="hljs-attr">"instructors"</span>: [
<span class="hljs-string">"Anwar Mamat"</span>
],
<span class="hljs-attr">"meetings"</span>: [
<span class="hljs-string">"TuTh-3:30pm-4:45pm-IRB-0318"</span>
],
<span class="hljs-attr">"open_seats"</span>: <span class="hljs-number">15</span>,
<span class="hljs-attr">"total_seats"</span>: <span class="hljs-number">50</span>,
<span class="hljs-attr">"waitlist"</span>: <span class="hljs-number">0</span>,
<span class="hljs-attr">"holdfile"</span>: <span class="hljs-literal">null</span>
}
]
</code></pre><h3 id="-v0-instructors-"><code>/v0/instructors</code></h3>
<p><a href="#endpoints">(back to endpoints)</a></p>
<p>Get a list of all instructors and their average ratings, including instructors not actively teaching any courses.</p>
<h4 id="query-parameters">Query parameters</h4>
<table>
<thead>
<tr>
<th style="text-align:left">param</th>
<th style="text-align:left">description</th>
<th style="text-align:left">example</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><code>instructorNames</code> (optional)</td>
<td style="text-align:left">A comma-separated list of instructor names to get results for. Cannot set both <code>instructorNames</code> and <code>instructorSlugs</code>.</td>
<td style="text-align:left"><code>instructorNames=Testudo%20Terrapin,Darryll%20Pines</code></td>
</tr>
<tr>
<td style="text-align:left"><code>instructorSlugs</code> (optional)</td>
<td style="text-align:left">A comma-separated list of instructor slugs to get results for; slugs are the internal identifier used to distinguish an instructor and are unique to each instructor. See PlanetTerp API spec for more info. Cannot set both <code>instructorNames</code> and <code>instructorSlugs</code>.</td>
<td style="text-align:left"><code>instructorSlugs=testudo,pines</code></td>
</tr>
<tr>
<td style="text-align:left"><code>ratings</code> (optional)</td>
<td style="text-align:left">A string of equalities/inequalities to filter instructors by their average rating on PlanetTerp. Possible equality/inequality expressions are: eq, lte, lt, gt, gte, neq (for equal to, less than or equal to, less than, etc.). For multiple conditions, use multiple ratings arguments.</td>
<td style="text-align:left"><code>ratings=gt.3.14&ratings=lt.5</code></td>
</tr>
<tr>
<td style="text-align:left"><code>limit</code> (optional)</td>
<td style="text-align:left">The number of results to return. Defaults to 100, maximum of 500.</td>
<td style="text-align:left"><code>limit=10</code></td>
</tr>
<tr>
<td style="text-align:left"><code>offset</code> (optional)</td>
<td style="text-align:left">How many records to skip when returning results; defaults to 0</td>
<td style="text-align:left"><code>offset=5</code></td>
</tr>
<tr>
<td style="text-align:left"><code>sortBy</code> (optional)</td>
<td style="text-align:left">A comma-separated list of which columns to sort by when returning; can be sorted in ascending (<code>.asc</code>) or descending (<code>.desc</code>) order.</td>
<td style="text-align:left"><code>sortBy=average_rating.asc,name.desc</code></td>
</tr>
</tbody>
</table>
<h4 id="output">Output</h4>
<table>
<thead>
<tr>
<th style="text-align:left">field</th>
<th style="text-align:center">type</th>
<th style="text-align:left">description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><code>slug</code></td>
<td style="text-align:center">string</td>
<td style="text-align:left">The internal string used to identify an individual instructor, unique to that instructor. See PlanetTerp API spec for more info.</td>
</tr>
<tr>
<td style="text-align:left"><code>name</code></td>
<td style="text-align:center">string</td>
<td style="text-align:left">The instructor's name as listed on PlanetTerp</td>
</tr>
<tr>
<td style="text-align:left"><code>average_rating</code></td>
<td style="text-align:center">float</td>
<td style="text-align:left">The average rating given to that professor from reviews on PlanetTerp</td>
</tr>
</tbody>
</table>
<h4 id="examples">Examples</h4>
<h5 id="getting-high-rated-non-5-star-instructors">Getting high-rated, non-5 star instructors</h5>
<p>Request: <code>GET http://api.jupiterp.com/v0/instructors?ratings=gt.4.5&ratings=lt.5&limit=5&sortBy=average_rating.desc,name.desc</code></p>
<p>Response:</p>
<pre><code>[
{
<span class="hljs-attr">"slug"</span>: <span class="hljs-string">"gramlich_meredith"</span>,
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Meredith Gramlich"</span>,
<span class="hljs-attr">"average_rating"</span>: <span class="hljs-number">4.9667</span>
},
{
<span class="hljs-attr">"slug"</span>: <span class="hljs-string">"cropper"</span>,
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Maureen Cropper"</span>,
<span class="hljs-attr">"average_rating"</span>: <span class="hljs-number">4.9474</span>
},
{
<span class="hljs-attr">"slug"</span>: <span class="hljs-string">"gruber_sean"</span>,
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Sean Gruber"</span>,
<span class="hljs-attr">"average_rating"</span>: <span class="hljs-number">4.9398</span>
},
{
<span class="hljs-attr">"slug"</span>: <span class="hljs-string">"o’brien"</span>,
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Terrence O’Brien"</span>,
<span class="hljs-attr">"average_rating"</span>: <span class="hljs-number">4.9375</span>
},
{
<span class="hljs-attr">"slug"</span>: <span class="hljs-string">"zomback"</span>,
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Jenna Zomback"</span>,
<span class="hljs-attr">"average_rating"</span>: <span class="hljs-number">4.9355</span>
}
]
</code></pre><h3 id="-v0-instructors-active-"><code>/v0/instructors/active</code></h3>
<p><a href="#endpoints">(back to endpoints)</a></p>
<p>Get all instructors that are currently teaching a course, as listed on Testudo.</p>
<h4 id="query-parameters">Query Parameters</h4>
<p>Same as <code>/v0/instructors</code>; see <a href="#-v0-instructors-">here</a>.</p>
<h4 id="output">Output</h4>
<p>Same as <code>/v0/instructors</code>; see <a href="#-v0-instructors-">here</a>.</p>
<h4 id="examples">Examples</h4>
<h5 id="getting-instructors-currently-teaching-a-course">Getting instructors currently teaching a course</h5>
<p>Request: <code>GET http://api.jupiterp.com/v0/instructors/active?limit=5</code></p>
<p>Response:</p>
<pre><code>[
{
<span class="hljs-attr">"slug"</span>: <span class="hljs-string">"abadi_daniel"</span>,
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Daniel Abadi"</span>,
<span class="hljs-attr">"average_rating"</span>: <span class="hljs-number">3.122</span>
},
{
<span class="hljs-attr">"slug"</span>: <span class="hljs-string">"abasi"</span>,
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Ali Abasi"</span>,
<span class="hljs-attr">"average_rating"</span>: <span class="hljs-literal">null</span>
},
{
<span class="hljs-attr">"slug"</span>: <span class="hljs-string">"abbasi"</span>,
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Hossein Abbasi"</span>,
<span class="hljs-attr">"average_rating"</span>: <span class="hljs-number">3.7791</span>
},
{
<span class="hljs-attr">"slug"</span>: <span class="hljs-string">"abdul-alim"</span>,
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Jamaal Abdul-Alim"</span>,
<span class="hljs-attr">"average_rating"</span>: <span class="hljs-number">3.25</span>
},
{
<span class="hljs-attr">"slug"</span>: <span class="hljs-string">"abioye"</span>,
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Victor Abioye"</span>,
<span class="hljs-attr">"average_rating"</span>: <span class="hljs-literal">null</span>
}
]
</code></pre><h3 id="-v0-deptlist-"><code>/v0/deptList</code></h3>
<p><a href="#endpoints">(back to endpoints)</a></p>
<p>Get a list of 4-letter department codes.</p>
<h4 id="query-parameters">Query parameters</h4>
<p>None</p>
<h4 id="output">Output</h4>
<table>
<thead>
<tr>
<th style="text-align:left">field</th>
<th style="text-align:center">type</th>
<th style="text-align:left">description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><code>dept_code</code></td>
<td style="text-align:center">string</td>
<td style="text-align:left">A unique 4-letter department code</td>
</tr>
<tr>
<td style="text-align:left"><code>name</code></td>
<td style="text-align:center">string</td>
<td style="text-align:left">The name of the department</td>
</tr>
</tbody>
</table>
</html>