-
Notifications
You must be signed in to change notification settings - Fork 1
/
openapi.yaml
1508 lines (1508 loc) · 51.3 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
swagger: '2.0'
info:
title: Students API
description: Get data specific to students.
version: v1
license:
name: GNU Affero General Public License Version 3
url: http://www.gnu.org/licenses/agpl-3.0.en.html
contact:
name: IS Data Architecture Team
url: https://is.oregonstate.edu/data-architecture
email: [email protected]
schemes:
- https
host: api.oregonstate.edu
basePath: /v1
externalDocs:
description: GitHub Repository
url: https://github.com/osu-mist/students-api
produces:
- application/json
consumes:
- application/json
security:
- OAuth2:
- full
paths:
/students/{osuId}/academic-status:
get:
tags:
- students
- academic-status
description: Get GPA and academic standing for each term a student is registered for.
operationId: getAcademicStatusById
parameters:
- $ref: '#/parameters/term'
- $ref: '#/parameters/osuId'
responses:
'200':
description: Successful response
schema:
$ref: '#/definitions/AcademicStatusResult'
'400':
description: Bad request
schema:
$ref: '#/definitions/ErrorResult'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorResult'
/students/{osuId}/account-balance:
get:
tags:
- students
- account-balance
description: Get a student's current account balance.
operationId: getAccountBalanceById
parameters:
- $ref: '#/parameters/osuId'
responses:
'200':
description: Successful response
schema:
$ref: '#/definitions/AccountBalanceResult'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorResult'
/students/{osuId}/account-transactions:
get:
tags:
- students
- account-transactions
description: Get a student's history of account transactions.
operationId: getAccountTransactionsById
parameters:
- $ref: '#/parameters/osuId'
- $ref: '#/parameters/term'
- in: query
name: transactionType
description: Filter transactions by type
required: false
type: string
enum: ['payment', 'charge']
- in: query
name: categories
description: |
Filter transactions by categories:
- `CSH` - Cash, Check, Credit Card
- `RET` - Returned Check Charge
- `FEE` - Registration Fees
- `TUI` - Registration Tuition
- `FA` - Financial Aid
- `RFD` - Refund
- `APF` - Admissions Application Charges
- `EXM` - Exemption Payments
- `CNT` - Contract Charges/Payments
- `INS` - Installment Charges/Payments
- `TRN` - Transcript Charges
- `DEP` - Deposit
- `BIL` - Billing Charges
- `HOU` - Housing
- `TFC` - Traffic
- `MSC` - Misc Reimbursements
- `MEA` - Meal Detail Codes
- `PHO` - Phone Detail Codes
- `OFE` - Other Registration Fees
- `FWD` - Balance Forward
- `NON` - Non use
- `VET` - Vet Med Category
- `CGA` - Cashier/Gen Accounting
- `GEN` - General Accounting
- `RES` - Research Accounting
- `COL` - Collections
- `INT` - International Education
- `HEA` - Health Center
- `REG` - Registrar
- `LIB` - Library
- `SLO` - Student Loans
- `PLC` - Placement Center
- `MUB` - Memorial Union
- `COU` - Counseling Center
- `UCS` - Computing Services
- `DCE` - Continuing Education
- `NBL` - No a/r statement
- `RMB` - Reimbursement Codes
- `ELN` - Emergency Loan
- `GRN` - Grant Billing
- `ALW` - Allowance Doubtful Accounts
- `AGP` - Agricultural Publications
- `HHS` - Health/Human Science
- `ATH` - Athletics
- `MPW` - Marketplace
- `NQC` - Nonuse 1098T Qualifying Chg
- `NSG` - Nonuse 1098T Scholarship/Grant
- `CCB` - Cascades Campus
- `IDC` - ID Center
- `N2` - INTO OSU
- `ASB` - Arts & Science Business Center
- `PPL` - Parent Plus Title IV Payment
- `FNR` - Nonrefundable Course Fees
- `NCR` - Non Cash Resources
required: false
type: array
collectionFormat: csv
items:
type: string
enum: [CSH ,RET ,FEE ,TUI ,FA ,RFD ,APF ,EXM ,CNT ,INS ,TRN ,DEP ,BIL ,HOU ,TFC ,MSC ,MEA ,PHO ,OFE ,FWD ,NON ,VET ,CGA ,GEN ,RES ,COL ,INT ,HEA ,REG ,LIB ,SLO ,PLC ,MUB ,COU ,UCS ,DCE ,NBL ,RMB ,ELN ,GRN ,ALW ,AGP ,HHS ,ATH ,MPW ,NQC ,NSG ,CCB ,IDC ,N2 ,ASB ,PPL ,FNR ,NCR]
responses:
'200':
description: Successful response
schema:
$ref: '#/definitions/AccountTransactionsResult'
'400':
description: Bad request
schema:
$ref: '#/definitions/ErrorResult'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorResult'
/students/{osuId}/classification:
get:
tags:
- students
- classification
description: Get a student's classification information
operationId: getClassificationById
parameters:
- $ref: '#/parameters/osuId'
responses:
'200':
description: Successful response
schema:
$ref: '#/definitions/ClassificationResult'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorResult'
/students/{osuId}/class-schedule:
get:
tags:
- students
- class-schedule
description: >
Get a student's class schedule. If no 'term' parameter is provided,
active registrations for all terms will be returned.
operationId: getClassScheduleById
parameters:
- $ref: '#/parameters/term'
- $ref: '#/parameters/osuId'
responses:
'200':
description: Successful response
schema:
$ref: '#/definitions/ClassScheduleResult'
'400':
description: Bad request
schema:
$ref: '#/definitions/ErrorResult'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorResult'
/students/{osuId}/degrees:
get:
tags:
- students
- degree
description: Get a student's degree, major, minor and college information
operationId: getDegreeById
parameters:
- $ref: '#/parameters/term'
- $ref: '#/parameters/osuId'
responses:
'200':
description: Successful response
schema:
$ref: '#/definitions/DegreesResult'
'400':
description: Bad request
schema:
$ref: '#/definitions/ErrorResult'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorResult'
/students/{osuId}/dual-enrollment:
get:
tags:
- students
- dual-enrollment
description: Get a student's enrolled credit hours from a dual enrollment institution.
operationId: getDualEnrollmentById
parameters:
- $ref: '#/parameters/term'
- $ref: '#/parameters/osuId'
responses:
'200':
description: Successful response
schema:
$ref: '#/definitions/DualEnrollmentResult'
'400':
description: Bad request
schema:
$ref: '#/definitions/ErrorResult'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorResult'
/students/{osuId}/gpa:
get:
tags:
- students
- gpa
description: Get a student's overall grade point averages.
operationId: getGradePointAverageById
parameters:
- $ref: '#/parameters/osuId'
responses:
'200':
description: Successful response
schema:
$ref: '#/definitions/GradePointAverageResult'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorResult'
/students/{osuId}/grades:
get:
tags:
- students
- grades
description: Get a student's final grades for their classes.
operationId: getGradesById
parameters:
- $ref: '#/parameters/term'
- $ref: '#/parameters/osuId'
responses:
'200':
description: Successful response
schema:
$ref: '#/definitions/GradesResult'
'400':
description: Bad request
schema:
$ref: '#/definitions/ErrorResult'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorResult'
/students/{osuId}/holds:
get:
tags:
- students
- holds
description: Get a student's current academic holds.
operationId: getHoldsById
parameters:
- $ref: '#/parameters/osuId'
- in: query
name: codes
description: Filter holds by codes
required: false
type: array
collectionFormat: csv
items: &HoldCode
type: string
enum: [AD, AM, AP, AR, AS, AW, BB, BC, BD, BG, BI, BL, BP, BR, BS, BU, CC, CE, CM, CP, CR, CS, CW, DC, DD, DG, DH, DP, DS, DT, EL, EN, EO, EP, ET, FA, GA, GD, GG, GM, GR, HA, HC, HH, HI, HS, HV, IN, IP, IS, IT, LF, LG, N2, N3, N4, N5, NB, ND, NH, NP, NR, PF, R1, R2, R3, R4, R5, R6, R7, R8, R9, RA, RB, RC, RD, RE, RF, RG, RH, RI, RJ, RM, RQ, RT, RY, SF, SL, SR, SS, TP, TR, VM, VT]
responses:
'200':
description: Successful response
schema:
$ref: '#/definitions/HoldsResult'
'400':
description: Bad request
schema:
$ref: '#/definitions/ErrorResult'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorResult'
/students/{osuId}/work-study:
get:
tags:
- students
- work-study
description: Get a student's available work study funding.
operationId: getWorkStudyById
parameters:
- $ref: '#/parameters/osuId'
responses:
'200':
description: Successful response
schema:
$ref: '#/definitions/WorkStudyResult'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorResult'
/students/{osuId}/emergency-contacts:
get:
tags:
- students
- emergency-contacts
description: Get a student's emergency contacts
operationId: getEmergencyContactById
parameters:
- $ref: '#/parameters/osuId'
responses:
'200':
description: Successful response
schema:
$ref: '#/definitions/EmergencyContactsResult'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorResult'
parameters:
osuId:
name: osuId
in: path
required: true
description: OSU ID of person
type: string
pattern: '^\d{9}$'
term:
name: term
in: query
required: false
pattern: '^\d{6}$|^current$'
description: >
Term code. Example: 201802. You can also specify 'current' to get the current term. During
academic breaks, the current term will be the current or the most future term. For example,
during spring break, the current term will be the spring term.
type: string
securityDefinitions:
OAuth2:
type: oauth2
flow: application
tokenUrl: https://api.oregonstate.edu/oauth2/token
scopes:
full: Full access to the API
definitions:
AcademicStatusResult:
properties:
links:
$ref: '#/definitions/SelfLink'
data:
type: array
items:
$ref: '#/definitions/AcademicStatusResource'
AcademicStatusResource:
properties:
id:
$ref: '#/definitions/StudentAndTermId'
type:
type: string
enum: [academic-status]
attributes:
properties:
academicStanding:
type: string
example: Good Standing
description: Academic standing
enum:
- Good Standing
- Academic Dismissal - Graduate
- Continued Deferred Suspension
- Honor Roll
- Academic Probation
- Special Deferred Suspension
- Academic Suspension
- Deferred Suspension
- Academic Warning
- Reinstatement After Suspension
term:
description: The term that this course was graded for.
type: string
example: '201901'
termDescription:
description: Description of the term.
type: string
example: Fall 2018
gpa:
description: Grade point averages for the given term.
type: array
items:
$ref: '#/definitions/GradePointAverage'
links:
$ref: '#/definitions/SelfLink'
AccountBalanceResult:
properties:
links:
$ref: '#/definitions/SelfLink'
data:
$ref: '#/definitions/AccountBalanceResource'
AccountBalanceResource:
properties:
id:
$ref: '#/definitions/StudentId'
type:
type: string
enum: [account-balance]
attributes:
properties:
currentBalance:
type: number
format: float
description: Current balance of student's account, in USD.
example: 2500.39
links:
$ref: '#/definitions/SelfLink'
AccountTransactionsResult:
properties:
links:
$ref: '#/definitions/SelfLink'
data:
$ref: '#/definitions/AccountTransactionsResource'
AccountTransactionsResource:
properties:
id:
$ref: '#/definitions/StudentId'
type:
type: string
enum: [account-transactions]
attributes:
properties:
transactions:
type: array
items:
properties:
amount:
type: number
format: float
description: Amount of money transferred for transaction, in USD.
example: 200.59
description:
type: string
description: Description of transaction.
example: Tuition Deposit Applied
categoryCode:
type: string
description: Transaction category code
example: IDC
category:
type: string
description: Transaction category
example: ID Center
entryDate:
type: string
format: date-time
description: Date the transaction was entered.
example: 2018-04-27T06:31:15Z
term:
description: The term that this transaction was occurred.
type: string
example: '201901'
transactionType:
type: string
description: Transaction Type
enum: [charge, payment]
example: charge
detailCode:
type: string
description: Transaction detail code
example: INC1
detail:
type: string
description: Transaction detail
example: Incidental Fee
links:
$ref: '#/definitions/SelfLink'
ClassificationResult:
properties:
links:
$ref: '#/definitions/SelfLink'
data:
$ref: '#/definitions/ClassificationResource'
ClassificationResource:
properties:
id:
$ref: '#/definitions/StudentId'
type:
type: string
enum: [classification]
attributes:
properties:
levelCode: &levelCode
description: |
Academic level code:
- `00` - Level Not Declared
- `02` - Graduate
- `03` - Postbac Degree Seeking
- `01` - Undergraduate
- `04` - Non-Degree / Credential
- `05` - Professional
- `CP` - Cascades Partner
- `CG` - Cascades Partner Grad Course
- `CX` - Obsolete - Do not use
- `D1` - E-Campus Undergraduate Course
- `D2` - E-Campus Graduate Course
- `DO` - E-Campus Overlay Course
- `DR` - E-Campus Intermediate Course
- `NC` - Non Credit
- `06` - INTO OSU GE/AE/Pathways
- `D3` - ECampus CCLP & Couseling PHD
type: string
enum: ['00', '02', '03', '01', '04', '05', 'CP', 'CG', 'CX', 'D1', 'D2', 'DO', 'DR', 'NC', '06', 'D3']
level:
description: Description of Academic level code
type: string
example: Undergraduate
classification:
description: Classification of a student
example: Sophomore
type: string
enum:
- Freshman
- Sophomore
- Junior
- Senior
- Vet Med-First Year
- Determine from Student Type
- Continuing Higher Education
- Vet Med-Second Year
- Vet Med-Third Year
- Vet Med-Fourth Year
- Auditor Only
campusCode: &campusCode
description: |
Campus code for a student.
- `A` - Ashland/SOU
- `DSC` - Dist. Degree Corvallis Student
- `O` - Portland - OCATE Center
- `E` - Eugene/UO
- `H` - Portland/OHSU
- `M` - Monmouth/WOU
- `DSB` - Dist. Degree Cascades Student
- `N` - Newport/HMSC
- `P` - Portland/PSU
- `K` - Klamath Falls/KCC/OIT
- `B` - Oregon State - Cascades
- `D0` - Ecampus-Distance Ed Bvrton/Hil
- `L` - LaGrande/EOU
- `C` - Oregon State - Corvallis
- `I` - OBSOLETE Dist & Online Courses
- `S` - Other States (Non-Oregon)
- `J` - Oregon State - Corvallis
- `Z` - International Sites
- `D3` - Ecampus-Distance Ed Salem/CCC
- `D4` - Ecampus-Distance Ed PDX/PCC
- `Q` - Central Oregon - Warm Springs
- `D5` - Ecampus-Distance Ed CosBaySWOC
- `D6` - Ecampus-Distance Ed Albany LBC
- `2` - Central Oregon - COCC, Bend
- `3` - Salem/CCC
- `4` - Portland/PCC
- `5` - Coos Bay/SWOCC
- `6` - Albany/LBCC
- `7` - Astoria/CCC
- `8` - Ontario/TVCC
- `9` - Pendleton/BMCC
- `V` - Hood River/The Dalles
- `X` - Medford/Grants Pass
- `Y` - Gresham/MHCC
- `0` - Beaverton/Hillsboro/Cptl Cntr
- `D7` - Ecampus-Distance Ed Astoria/CC
- `D8` - Ecampus-Distance Ed Ontario
- `D9` - Ecampus-Distance Ed Pdleton/BM
- `DA` - Ecampus-Distance Ed Ashld/SOU
- `DE` - Ecampus-Distance Ed Eugene/UO
- `DH` - Ecampus-Distance Ed PDX/OHSU
- `DK` - Ecampus-Distance Ed Klmth Fals
- `DL` - Ecampus-Distance Ed LaGd/EOU
- `DM` - Ecampus-Distance Ed Monmth/WOU
- `DN` - Ecampus-Distance Ed Newpt/HMSC
- `DO` - Ecampus-Distance Ed PDX-OCATE
- `DP` - Ecampus-Distance Ed PDX - PSU
- `DQ` - Ecampus-Distance Ed WRM SPRS
- `DS` - Ecampus-Distance Ed Other US
- `DV` - Ecampus-Distance Ed Hood River
- `DX` - Ecampus-Distance Ed Medfrd
- `DY` - Ecampus-Distance Ed /MHCC
- `DZ` - Ecampus-Distance Ed Internatl
- `D1` - Ecampus-Distance Ed Overlay
- `DI` - Ecampus-Distance Education-LD
- `DB` - Ecampus-Distance Education-UD
- `DR` - Ecampus-Dist Ed Intermediate
- `DJ` - Ecampus-Distance Ed OSU Campus
- `D2` - Ecampus-Distance Ed Centl. OR
- `DC` - Ecampus-Dist Ed-UD-Cascades
- `DT` - Ecampus-Dist ED Clackamas
- `DLP` - ECampus-Comm Coll Leadrshp Pgm
- `PDX` - Oregon State - Portland
type: string
enum: [A, DSC, O, E, H, M, DSB, N, P, K, B, D0, L, C, I, S, J, Z, D3, D4, Q, D5, D6, 2, 3, 4, 5, 6, 7, 8, 9, V, X, Y, 0, D7, D8, D9, DA, DE, DH, DK, DL, DM, DN, DO, DP, DQ, DS, DV, DX, DY, DZ, D1, DI, DB, DR, DJ, D2, DC, DT, DLP, PDX]
campus:
description: Campus for a student
example: Oregon State - Corvallis
type: string
status:
description: Student status
example: New Student
type: string
enum:
- New Student
- Inactive Student
- Withdrawn Student
- Continuing
- Readmit/Old Returning
- Summer Only Student
- Continuing Higher Education
- Auditor
- Non-matriculated student
isInternational:
description: Identifies whether the student is international student.
type: boolean
studentTypeCode:
description: |
Student type code:
- `0`- Undeclared
- `1`- Freshman < 24 hours
- `2`- Freshman - Early Admit
- `3`- GED
- `4`- Credential
- `5`- Non-Degree Undergrad
- `6`- Non-Degree Graduate
- `7`- Post Baccalaureate
- `8`- Masters
- `9`- Doctoral
- `A`- Auditor Only
- `C`- Continuing Higher Education
- `G`- Post Bac Graduate
- `H`- Graduate Certificate
- `K`- K-12 Online
- `N`- Non-Credit
- `P`- Doctor of Pharmacy
- `R`- Readmit
- `S`- Summer Only
- `T`- Transfer
- `V`- Veterinary Medicine
- `W`- INTO OSU Graduate Pathways
- `X`- INTO OSU General English
- `Y`- INTO OSU Academic English
- `Z`- INTO OSU Undergrad Pathways
type: string
enum: ['0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'C', 'G', 'H', 'K', 'N', 'P', 'R', 'S', 'T', 'V', 'W', 'X', 'Y', 'Z']
studentType:
description: Description of student type
type: string
example: INTO OSU Graduate Pathways
links:
$ref: '#/definitions/SelfLink'
ClassScheduleResult:
properties:
links:
$ref: '#/definitions/SelfLink'
data:
type: array
items:
$ref: '#/definitions/ClassScheduleResource'
ClassScheduleResource:
properties:
id:
$ref: '#/definitions/StudentAndTermAndCourseId'
type:
type: string
enum: [class-schedule]
attributes:
properties:
academicYear:
description: Code value to identify the academic year for the term.
type: string
example: '1819'
academicYearDescription:
description: Short summary of the academic year for the term.
type: string
example: Academic Year 2018-19
courseReferenceNumber:
description: Uniquely identifies a course section for a given term.
type: string
example: '123456'
courseSubject:
description: Abbreviated course subject.
type: string
example: ECON
courseSubjectDescription:
description: Description of course subject.
type: string
example: Economics
courseNumber:
type: string
example: '352'
courseTitle:
description: Title of the course.
type: string
example: Environmental Economics & Policy
sectionNumber:
description: The unique section of a specific course number.
type: string
example: '001'
term:
description: The term that this course is scheduled for.
type: string
example: '201901'
termDescription:
description: Description of the term.
type: string
example: Fall 2018
scheduleDescription:
description: Human readable schedule type for the course (agnostic of meeting times).
type: string
example: Lecture
scheduleType:
description: Type of schedule for the course (agnostic of meeting times).
type: string
example: A
enum: [B, C, D, E, F, G, H, I, J, K, A, L, M, N, O, P , Q, R, S, T, U, W, Y, Z, V, X, MID, FIL, HYB]
creditHours:
description: Credit hours of the course.
type: integer
example: 3
registrationStatus:
description: The student's registration status for the course.
type: string
example: Web Registered
gradingMode:
description: The grading mode for the course.
type: string
example: Normal Grading Mode
continuingEducation:
description: Identifies whether the course is enrolled for continuing education credits.
type: boolean
faculty:
description: Faculty and instructors associated with this course.
type: array
items:
properties:
osuId:
description: Person ID for the faculty.
type: string
example: '937654321'
name:
description: Display name of the faculty.
type: string
example: Johnson, Bob
email:
description: Email address of the faculty.
type: string
example: [email protected]
primary:
description: Indicates whether the faculty is the primary faculty for the course.
type: boolean
example: true
meetingTimes:
description: Weekly meeting times for the course.
type: array
items:
properties:
beginDate:
description: The starting date of the meeting time schedule.
type: string
format: date
example: 2018-09-20
beginTime:
description: The starting time of the meeting time for the course in 24 hour format.
type: string
example: 14:00:00
endDate:
description: The ending date of the meeting time schedule.
type: string
format: date
example: 2018-11-30
endTime:
description: The starting time of the meeting time for the course in 24 hour format.
type: string
example: 14:50:00
room:
description: Room where the meeting time meets.
type: string
example: '100'
building:
description: The building abbreviation of the meeting time.
type: string
example: LINC
buildingDescription:
description: The name of the building.
type: string
example: Learning Innovation Center
campusCode: *campusCode
campus:
description: Campus location of the meeting time.
type: string
example: Oregon State - Corvallis
hoursPerWeek:
description: The amount of hours this meeting time meets per week.
type: number
format: float
example: 1.66
creditHourSession:
description: Session credit hours for this meeting time.
type: integer
example: 2
scheduleType:
description: |
Type of schedule for this given meeting type.
- `A` - Lecture
- `B` - Discussion
- `C` - Recitation
- `D` - Laboratory
- `E` - Seminar
- `F` - Independent or Special Studies
- `G` - Research
- `H` - Activity
- `I` - Experimental
- `J` - Internship
- `K` - Streaming Media
- `L` - Tutorial
- `M` - Practicum
- `N` - Reading and Conference
- `O` - Experiential/Co-op Education
- `P` - Programmed Instruction
- `Q` - Thesis
- `R` - Studio
- `S` - Project
- `T` - Telecourse/Distance Learning
- `U` - Externship
- `W` - Workshop
- `Y` - Online
- `Z` - Modular
- `V` - Examination for Credit
- `X` - One-time Event
- `MD` - Midterm Exam
- `FL` - Final Exam
- `HB` - Hybrid
type: string
example: A
enum: [B, C, D, E, F, G, H, I, J, K, A, L, M, N, O, P , Q, R, S, T, U, W, Y, Z, V, X, MID, FIL, HYB]
scheduleDescription:
description: Human readable schedule type for the course (agnostic of meeting times).
type: string
example: Lecture
weeklySchedule:
description: |
Array of day abbreviations to represent which days of the week this meeting time occurs on.
If an abbreviation is present in the array, the meeting time meets on that day of the week.
The meeting time does not meet on any days of the week which aren't in the array.
Abbreviations and their corresponding day of the week:
- `M`: - Monday
- `T`: - Tuesday
- `W`: - Wednesday
- `Th` - Thursday
- `F` - Friday
- `Sa` - Saturday
- `Su` - Sunday
type: array
example: [M, W, F]
items:
type: string
enum: [M, T, W, Th, F, Sa, Su]
repeatedCourseInd: &repeatedCourseInd
description: |
Identifies whether the course is repeated course.
- `null` - Included
- `A` - Include to only count in GPA
- `E` - Excluded
- `I` - Re-included after being excluded
type: string
enum: [null, 'A', 'E', 'I']
links:
$ref: '#/definitions/SelfLink'
DegreesResult:
properties:
links:
$ref: '#/definitions/SelfLink'
data:
type: array
items:
$ref: '#/definitions/DegreeResource'
DegreeResource:
properties:
id:
$ref: '#/definitions/StudentAndTermAndProgramNumber'
type:
type: string
enum: [degree]
attributes:
properties:
term:
description: The term that this course is scheduled for
type: string
example: '201901'
termDescription:
description: Description of the term
type: string
example: Fall 2018
academicYear:
description: Code value to identify the academic year for the term
type: string
example: '1819'
academicYearDescription:
description: Short summary of the academic year for the term
type: string
example: Academic Year 2018-19
programNumber:
description: >
The program number indicates the program priority. For example, 1
stands for the primary degree.
type: number
format: integer
example: 1
primaryDegree:
description: A boolean value indicates if the degree is primary or not
type: boolean
example: true
degree:
description: The student degree
type: string
example: Bachelor of Science
level:
description: The degree level
type: string
example: Undergraduate
college:
description: The college of the degree
type: string
example: College of Liberal Arts
degreeAwardCategory:
description: Degree award category
type: string
example: Baccalaureate Degree
majors:
properties:
first:
$ref: '#/definitions/Major'
second:
$ref: '#/definitions/Major'
third:
$ref: '#/definitions/Major'
fourth:
$ref: '#/definitions/Major'
description: Majors information
minors:
properties:
first:
$ref: '#/definitions/Minor'
second:
$ref: '#/definitions/Minor'
third:
$ref: '#/definitions/Minor'
fourth:
$ref: '#/definitions/Minor'
description: Minors information
dualDegree:
properties:
degree:
description: The student's dual degree
type: string
example: Bachelor of Science