-
Notifications
You must be signed in to change notification settings - Fork 1
/
openapi.yaml
2025 lines (2025 loc) · 62.9 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
openapi: 3.0.0
info:
title: Persons API
description: Get information about people at OSU.
version: v2
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: isdataarchitecture@oregonstate.edu
servers:
- url: https://api.oregonstate.edu/v2
externalDocs:
description: GitHub Repository
url: https://github.com/osu-mist/persons-api
security:
- OAuth2:
- full
paths:
/persons:
post:
description: Create a person
summary: Create a person
tags:
- persons
operationId: postPerson
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PersonPostBody'
required: true
responses:
'202':
description: The backend data source needs to do additional processing with the
new person record. Person record accepted but not yet created.
content:
application/json:
schema:
$ref: '#/components/schemas/PersonResult'
'400':
$ref: '#/components/responses/400'
'409':
$ref: '#/components/responses/409Post'
'500':
$ref: '#/components/responses/500'
/persons/{osuId}:
get:
description: Get general person information
summary: Get general person information
tags:
- persons
operationId: getPersonById
parameters:
- $ref: '#/components/parameters/osuId'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/PersonResult'
'400':
$ref: '#/components/responses/400'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
/persons/{osuId}/jobs:
get:
description: Get jobs associated with a person
summary: Get jobs associated with a person
tags:
- jobs
operationId: getJobs
parameters:
- $ref: '#/components/parameters/osuId'
- name: filter[positionNumber]
in: query
required: false
description: Filter by position ID.
schema:
type: string
- name: filter[suffix]
in: query
required: false
description: >-
Filter by suffix. The suffix is used to differentiate multiple jobs
that share the same position number for a given person.
schema:
type: string
- name: filter[statusCode]
in: query
required: false
description: |
Filter by the status of the job
- `A` - Active
- `B` - Leave without pay but with benefits
- `L` - Leave without pay and benefits
- `F` - Leave with full pay and benefits
- `P` - Leave with partial pay and benefits
- `T` - Terminated
schema:
type: string
enum: &statusCodeEnums [A, B, L, F, P, T]
- name: filter[campusCode]
in: query
required: false
description: |
Filter results by campus ID. Common campus IDs:
- `02A` - Corvallis
- `09A` - Bend
- `21B` - Newport
- `31E` - Eastern
- `26C` - Portland
schema:
type: string
enum: ['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', '33D',
'33E', '33F', '33G', '34A', '34B', '34C', '34D', '34E', '34F', '34G', '34H', '34I',
'35A', '35B', '36A', '36B', '36C', '36D', '36E', '36F', '36G', '36H', '36I', '37', '40',
'41', '42', '43', '44', '45', '46', '29E', '29F', '29G', '30A', '30B', '30C', '30D',
'30E', '30F', '30G', '30H', '30I', '30J', '30K', '30L', '31A', '31B', '31C', '31D',
'31E', '31F', '31G', '31H', '32A', '32B', '32C', '32D', '33A', '33B', '33C', '24M',
'24N', '24O', '24P', '24Q', '24R', '24S', '25A', '25B', '25C', '25D', '25E', '26A',
'26B', '26C', '26D', '26E', '27A', '27B', '27C', '27D', '27E', '28A', '28B', '28C',
'29A', '29B', '29C', '29D', '21B', '21C', '21D', '21E', '22A', '22B', '22C', '22D',
'22E', '22F', '22G', '22H', '22I', '23A', '23B', '23C', '23D', '23E', '23F', '24A',
'24B', '24C', '24D', '24E', '24F', '24G', '24H', '24I', '24J', '24K', '24L', '15E',
'15F', '15G', '15H', '15I', '15J', '16A', '16B', '16C', '17A', '17B', '18A', '18B',
'18C', '18D', '18E', '19A', '19B', '19C', '20A', '20B', '20C', '20D', '20E', '20F',
'20G', '20H', '20I', '21A', '10F', '10G', '10H', '10I', '10J', '10K', '11A', '11B',
'11C', '12A', '12B', '12C', '12D', '12E', '12F', '12G', '12H', '12I', '13A', '13B',
'13C', '13D', '13E', '14A', '14B', '15A', '15B', '15C', '15D', '01A', '01B', '01C',
'01D', '01E', '01F', '01G', '01H', '01I', '02A', '02B', '02C', '03A', '03B', '03C',
'03D', '03E', '03F', '03G', '03H', '03I', '03J', '03K', '03L', '04A', '04B', '04C',
'04D', '04E', '05A', '05B', '05C', '05D', '05E', '05F', '05G', '05H', '06A', '06B',
'06C', '06D', '06E', '06F', '06G', '06H', '06I', '07A', '08A', '08B', '08C', '09A',
'09B', '09C', '10A', '10B', '10C', '10D', '10E', '87', '88', '89', '16D', '34J', '20J',
'03M', '02D', '02E', '07B', '13F', '25F', '06J', '05I', '03N', '34K', '20K', '34L',
'24T', '10L', '09D', '09E', '27F', '20L', '37A', '27G', '22J']
- $ref: '#/components/parameters/studentEmployeeInd'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/JobSetResult'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
post:
description: Create a job record for a person
summary: Create a job record for a person
tags:
- jobs
operationId: postJob
parameters:
- $ref: '#/components/parameters/osuId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/JobPostBody'
required: true
responses:
'202':
description: The backend data source needs to do additional processing with the
new job record. Job record accepted but not yet created.
content:
application/json:
schema:
$ref: '#/components/schemas/JobResult'
'400':
$ref: '#/components/responses/400'
'404':
$ref: '#/components/responses/404'
'409':
$ref: '#/components/responses/409Post'
'500':
$ref: '#/components/responses/500'
/persons/{osuId}/jobs/{jobId}:
get:
description: Get a specific job associated with a person
summary: Get a specific job associated with a person
tags:
- jobs
operationId: getJobById
parameters:
- $ref: '#/components/parameters/osuId'
- $ref: '#/components/parameters/jobId'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/JobResult'
'400':
$ref: '#/components/responses/400'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
patch:
description: Update a job record for a person
summary: Update a job record for a person
tags:
- jobs
operationId: patchJobById
parameters:
- $ref: '#/components/parameters/osuId'
- $ref: '#/components/parameters/jobId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/JobPatchBody'
description: patch body for a job
required: true
responses:
'202':
description: The backend data source needs to do additional processing with the
updated job record. Job record accepted but not yet updated.
content:
application/json:
schema:
$ref: '#/components/schemas/JobResult'
'400':
$ref: '#/components/responses/400'
'404':
$ref: '#/components/responses/404'
'409':
$ref: '#/components/responses/409Patch'
'500':
$ref: '#/components/responses/500'
/persons/{osuId}/ssn:
post:
description: Create a person's SSN
summary: Create a person's SSN
tags:
- ssn
operationId: postSsn
parameters:
- $ref: '#/components/parameters/osuId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SsnPostBody'
description: SSN post body
required: true
responses:
'204':
description: SSN accepted
'400':
$ref: '#/components/responses/400'
'404':
$ref: '#/components/responses/404'
'409':
$ref: '#/components/responses/409Post'
'500':
$ref: '#/components/responses/500'
/persons/{osuId}/images:
get:
description: Get a person's image
summary: Get a person's image
tags:
- images
operationId: getImages
parameters:
- $ref: '#/components/parameters/osuId'
- $ref: '#/components/parameters/imageWidth'
responses:
'200':
description: Successful response
content:
image/jpeg:
schema:
type: string
format: binary
'400':
$ref: '#/components/responses/400'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
/persons/{osuId}/meal-plans:
get:
description: Get meal plans for a person
summary: Get meal plans for a person
tags:
- meal-plans
operationId: getMealPlans
parameters:
- $ref: '#/components/parameters/osuId'
- name: filter[balance][gt]
in: query
required: false
description: Filter results based on the remaining balance.
schema:
type: number
format: float
- name: filter[balance][gte]
in: query
required: false
description: Filter results based on the remaining balance.
schema:
type: number
format: float
- name: filter[lastUsedDateTime][lte]
in: query
required: false
description: Filter results based on the last date and time the meal-plan was
used.
schema:
type: string
format: date-time
- name: filter[lastUsedDateTime][gte]
in: query
required: false
description: Filter results based on the last date and time the meal-plan was used.
schema:
type: string
format: date-time
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MealPlanSetResult'
'400':
$ref: '#/components/responses/400'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
/persons/{osuId}/meal-plans/{mealPlanId}:
get:
description: Get a specific meal plan for a person
summary: Get a specific meal plan for a person
tags:
- meal-plans
operationId: getMealPlanById
parameters:
- $ref: '#/components/parameters/osuId'
- $ref: '#/components/parameters/mealPlanId'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MealPlanResult'
'400':
$ref: '#/components/responses/400'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
/persons/{osuId}/addresses:
get:
description: Get addresses for a person
summary: Get addresses for a person
tags:
- addresses
operationId: getAddresses
parameters:
- $ref: '#/components/parameters/osuId'
- name: filter[city]
in: query
required: false
description: Filter results by city.
schema:
type: string
- name: filter[county]
in: query
required: false
description: Filter results by county.
schema:
type: string
- name: filter[stateCode]
in: query
required: false
description: Filter results by state code.
schema:
type: string
enum:
&stateCodeEnums [DE, NJ, PA, DC, NY, CA, VA, NC, TX, FL, HI, WV, MT, GA, MD, OH, IN,
AK, AL, AR, AZ, CO, CT, IA, ID, IL, KS, KY, LA, MA, ME, MI, MN, MO, MS, ND, NE, NH,
NM, NV, OK, OR, RI, SC, SD, TN, UT, VT, WA, WI, WY, VI, TT, PR, GU, CZ, AS, BC, NT,
AB, ON, SK, NB, NF, NS, PE, PQ, MP, FM, MH, PW, MB, YT, AP, AE, AA, FC, FR, NU, BY,
ENG]
- name: filter[nationCode]
in: query
required: false
description: Filter results by nation code.
schema:
type: string
enum:
&nationCodeEnums [FPL, ARE, ARW, KSA, QSG, ESL, GES, CSD, KSY, HTT, ETG, JUY, JVE,
KYD, AZM, FAL, GAD, JAR, HBS, KBH, PBT, ABI, QBU, LCA, BCG, OTW, OCN, ICR, GDK, ISV,
AET, NPF, BGA, SGL, HHT, GIS, KIQ, HJM, AKE, DLS, CLY, GMC, HMQ, AMZ, NPG, ENE, MNZ,
JPY, HAI, HAG, EBJ, FBY, MCX, NCK, JFK, NGU, HLC, FAM, FMD, FEE, FLT, OMO, FHR, DNA,
JGY, GDE, HPM, QVN, QBN, CEH, RHM, HKN, NNR, NPN, BST, NTK, FMK, FSR, FTX, FTI, QMM,
AER, FBO, FAJ, NSB, FUA, FRU, FGE, FBA, GAT, FYU, LBM, RBV, BCF, MCC, HCU, HDO, QTP,
CEG, JGF, GGR, HGD, EGN, OHK, KIR, KIL, KJO, KLB, GLU, AMG, GMT, AYO, IMX, OMN, GNL,
NNC, ENG, OKP, PPK, JPE, KQA, FRO, ESN, ADJ, DZA, HVC, KOM, JSR, ATZ, CTN, NTV, GGB,
NVU, NWF, FBG, QID, GIT, GPT, AZW, FSK, BCM, DBW, EGW, EML, FHU, FKZ, GCH, GLI, GSM,
HBB, HVG, IGT, KAE, KKW, NFJ, QKH, QPH, NUM, KGZ, FKK, HBL, COD, ASO, PLK, GSE, DSZ,
QTH, KTR, GVA, NWS, BZR, PAF, CDZ, BAO, MAU, PBD, GBE, IBZ, JBO, JBR, PIO, BTD, JCL,
JCO, ECV, KCY, JEC, BGQ, GFI, GFR, EGM, HGP, IHN, GIE, ECI, OJP, OKR, ELR, AMW, CMA,
AMU, QMY, PNP, INI, GNO, IPA, LUS, RAQ, HAW, EBF, HKY, AKM, HDM, GFO, RTF, FKG, FUZ,
FLV, PMV, FSI, HAN, EGH, PIN, EMR, AUG, KYE, NTO, GGI, NKI, HMS, NNU, ASC, HTC, FEZ,
FMW, NNF, QLA, IAN, KWE, FTM, HMF, FKV]
- $ref: '#/components/parameters/addressType'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/AddressSetResult'
'400':
$ref: '#/components/responses/400'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
/persons/{osuId}/phones:
get:
description: Get phone numbers for a person
summary: Get phone numbers for a person
tags:
- phones
operationId: getPhones
parameters:
- $ref: '#/components/parameters/osuId'
- $ref: '#/components/parameters/addressType'
- $ref: '#/components/parameters/phoneType'
- name: filter[primaryInd]
in: query
required: false
description: Filter on primary or non-primary phone numbers
schema:
type: boolean
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/PhoneSetResult'
'400':
$ref: '#/components/responses/400'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
/persons/{osuId}/emails:
get:
description: Get emails for a person
summary: Get emails for a person
tags:
- emails
operationId: getEmails
parameters:
- $ref: '#/components/parameters/osuId'
- name: filter[emailType]
in: query
required: false
description: |
Type of email
- `ONID` - Student
- `STU` - Non-directory Student
- `VEND` - Vendor
- `VWEB` - Vendor
- `EMPL` - Employee
- `VPAY` - Vendor Pay
- `EMER` - Emergency Contact Persons Email for Student
schema:
type: array
items:
type: string
enum:
&emailTypeEnums [ONID, STU, VEND, VWEB, EMPL, VPAY, EMER]
- name: filter[preferredInd]
in: query
description: Filter on preferred email addresses
schema:
type: boolean
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/EmailSetResult'
'400':
$ref: '#/components/responses/400'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
/persons/{osuId}/medical:
get:
description: Get medical data for a person
summary: Get medical data for a person
tags:
- medical
operationId: getMedical
parameters:
- $ref: '#/components/parameters/osuId'
- name: filter[medicalType]
in: query
required: false
description: &medicalTypeDescription |
Type of medical record
- `LD` - Learning Disabled
- `MU` - mumps missing
- `ID` - inpatient diagnosis
- `IP` - inpatient practitioner
- `TW` - temp immunization waiver signd
- `CA` - completed all immunizations
- `MBEM` - MenB Exception Medical
- `AA` - Alcohol Dependent
- `HH` - Health History missing
- `M2` - Second measles missing
- `CT` - Clear T.B. requirement
- `DISABSURV` - Disability Survey
- `HAC` - Haven Complete
- `HAR` - Haven Required
- `NHB` - Needs Hepatitis B requirement
- `NVAR` - Needs Varicella Requirement
- `CICR` - CIC Required
- `MBB1` - Bexsero 1
- `MBB2` - Bexsero 2
- `AI` - All immunizations missing
- `TA` - T.B. Testing needed
- `FO` - Health History Form Only
- `AR` - Archives
- `CICC` - CIC Complete
- `MBEN` - MenB Exception Non-Medical
- `RU` - Rubella missing
- `TE` - Taking INH
- `TG` - T.B. testing complete
- `WD` - Withdrawn
- `TH` - Needing INH Counseling
- `TK` - Completed INH Counseling
- `AER` - Alcohol.edu Required
- `NMCV` - Needs MCV4 requirement
- `MBT1` - Trumenba 1
- `PP` - Paraplegic
- `M1` - First measles missing
- `TB` - T.B. CXR needed
- `IA` - Inpatient Admit/Discharge
- `NMB` - Meng B Form - Not Proof of Vax
- `CI` - Completed MMR and MCV4 Reqmnt
- `TC` - T.B. F.U. needed
- `TD` - PPD positive
- `TF` - Completed INH
- `CICW` - CIC Waived
- `ST` - Storage
- `NTD` - Needs Tdap Requirement
- `COVIDVACC` - COVID-19 Vaccine Completed
- `MBT3` - Trumenba 3
- `MBFA` - MenB Former Academic Exception
- `ER` - Early Registration
- `OC` - Occupational Medicine
- `PW` - Perm Immunization Waiver Signd
- `CH` - Clear Health Hist requirement
- `AEC` - Alcohol.edu Complete
- `NMMR` - Needs MMR requirement
- `MBT2` - Trumenba 2
schema:
type: array
items:
type: string
enum:
&medicalTypeEnums [LD, MU, ID, IP, TW, CA, MBEM, AA, HH, M2, CT, DISABSURV, HAC, HAR,
NHB, NVAR, CICR, MBB1, MBB2, AI, TA, FO, AR, CICC, MBEN, RU, TE,
TG, WD, TH, TK, AER, NMCV, MBT1, PP, M1, TB, IA, NMB, CI, TC, TD,
TF, CICW, ST, NTD, COVIDVACC, MBT3, MBFA, ER, OC, PW, CH, AEC,
NMMR, MBT2]
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MedicalSetResult'
'400':
$ref: '#/components/responses/400'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
components:
parameters:
osuId:
name: osuId
in: path
required: true
description: OSU ID of a person
schema:
type: string
pattern: ^\d{9}$
jobId:
name: jobId
in: path
description: ID of the specific job to be updated
required: true
schema:
type: string
imageWidth:
in: query
name: width
description: Resizes image to a pixel value for width while keeping original
aspect ratio
required: false
schema:
type: integer
minimum: 1
maximum: 2000
mealPlanId:
name: mealPlanId
in: path
description: ID of meal plan
required: true
schema:
type: string
pattern: '^[0-9]+$'
studentEmployeeInd:
name: filter[studentEmployeeInd]
in: query
description: Filter if job is a student job or not
required: false
schema:
type: boolean
addressType:
name: filter[addressType]
in: query
required: false
description: |
Filter by address type. Common address types and their description:
- `PA` - Student Alternate Contact
- `RN` - Geographic Origin-First Admit
- `RB` - Research Billing
- `RE` - Billing Address
- `RK` - Financial Aid Address
- `VO` - Vendor Order
- `VP` - Vendor Payment
- `XX` - Reserved for TGRFEED Use Only
- `CM` - Current Mailing
- `DM` - Department (US Mail)
- `EO` - Employee Office (Directory)
- `RH` - Residence Hall
- `PR` - Payroll W2 Address
- `MA` - Reserved for SRTLOAD Use Only
- `SV` - International -SEVIS
- `JA` - Job Application (HR use only)
schema:
type: string
enum:
&addressTypeEnums [PA, RN, RB, RE, RK, VO, VP, XX, CM, DM, EO, RH, PR, MA, SV, JA]
phoneType:
name: filter[phoneType]
in: query
required: false
description: |
Filter by phone type. Phone types and their descriptions:
- `PA` - Student Alternate Contact
- `RN` - Geographic Origin-First Admit
- `RB` - Research Billing
- `MG` - Mailing Address (Grades)
- `RE` - Billing Phone
- `RK` - Financial Aid Address
- `VO` - Vendor Order
- `VP` - Vendor Payment
- `VF` - Vendor Fax
- `CM` - Current
- `EO` - Employee Office (Directory)
- `RH` - Residence Hall
- `EF` - Employee Office Fax
- `MP` - Mobile Phone
schema:
type: string
enum:
&phoneTypeEnums [PA, RN, RB, MG, RE, RK, VO, VP, VF, CM, EO, RH, EF, MP]
responses:
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResult'
'404':
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResult'
'409Post':
description: >-
The request body resource object's type was invalid or, if a client-generated ID was used, a
resource already exists with this ID
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResult'
'409Patch':
description: >-
The request body resource object had an invalid type, invalid ID, or violated a uniqueness
constraint
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResult'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResult'
securitySchemes:
OAuth2:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://api.oregonstate.edu/oauth2/token
scopes:
full: Full access to the API
schemas:
PersonType:
type: string
enum: [person]
JobType:
type: string
enum: [jobs]
SsnType:
type: string
enum: [ssn]
MealPlanType:
type: string
enum: [meal-plans]
AddressType:
type: string
enum: [addresses]
PhoneType:
type: string
enum: [phones]
EmailType:
type: string
enum: [emails]
MedicalType:
type: string
enum: [medical]
PersonPostRequired:
type: object
required:
- firstName
- lastName
- birthDate
- sex
properties:
sex:
nullable: false
citizen:
type: object
required:
- code
properties:
code:
nullable: false
PersonPostAttributes:
type: object
additionalProperties: false
properties:
firstName:
type: string
nullable: false
description: First name of person
example: John
lastName:
type: string
nullable: false
description: Last name of person
example: Smith
middleName:
type: string
nullable: true
description: Middle name of person
example: Adam
birthDate:
type: string
nullable: false
format: date
description: Birthday of person
example: '1970-01-21'
citizen:
type: object
properties:
code:
type: string
enum: [FN, N, R, S, C]
description: |
Person's citizen code
- `FN` - Foreign National
- `N` - Non Resident Alien
- `R` - Resident Alien
- `S` - Substantial Presence Alien
- `C` - Citizen
sex:
type: string
enum: [M, F, N]
description: |
Person's sex code
- `M` - Male
- `F` - Female
- `N` - Non-specified
PersonAttributes:
type: object
properties:
sex:
nullable: true
displayFirstName:
type: string
nullable: true
description: Preferred first name
example: John
displayMiddleName:
type: string
nullable: true
description: Preferred middle name
example: Adam
displayLastName:
type: string
nullable: true
description: Preferred last name
example: Smith
onid:
type: string
nullable: true
description: ONID username
example: smithj
gybonid:
type: object
properties:
emailAddress:
type: string
nullable: true
description: GYBONID primary email address
example: smithj@example.com
phoneNumber:
type: string
nullable: true
description: GYBONID phone number
example: 1 555 444 3333
confidentialInd:
type: boolean
nullable: false
description: If true, the person has opted in to being required to be listed as
confidential
currentStudentInd:
type: boolean
nullable: false
description: True if person is a current student
employeeStatus:
type: object
properties:
code:
type: string
nullable: true
enum: [A, B, L, F, P, T]
description: |
The status of the employee:
- `A` - Active
- `B` - Leave without pay and with benefits
- `L` - Leave without pay and without benefits
- `F` - Leave with pay and with benefits
- `P` - Leave with partial pay and with benefits
- `T` - Terminated
description:
type: string
nullable: true
description: Description of employee status code
example: Active
ssnStatus:
type: string
nullable: true
enum: [vault, valid, invalid]
description: SSN status
citizen:
type: object
properties:
code:
nullable: true
description:
type: string
nullable: true
description: Description field for the code
lastPaidDate:
type: string
format: date
nullable: true
example: '2019-06-30'
description: Most recent date the employee was paid
PersonResource:
type: object
properties:
id:
type: string
description: OSU ID of a person
pattern: ^\d{9}$
type:
$ref: '#/components/schemas/PersonType'
links:
$ref: '#/components/schemas/SelfLink'
attributes:
allOf:
- $ref: '#/components/schemas/PersonPostAttributes'
- $ref: '#/components/schemas/PersonAttributes'
PersonResult:
type: object
properties:
links:
$ref: '#/components/schemas/SelfLink'
data:
$ref: '#/components/schemas/PersonResource'
PersonPostBody:
type: object
required:
- data
additionalProperties: false
properties:
data:
type: object
required:
- type
- attributes
additionalProperties: false
properties:
type:
$ref: '#/components/schemas/PersonType'
attributes:
allOf:
- $ref: '#/components/schemas/PersonPostRequired'
- $ref: '#/components/schemas/PersonPostAttributes'
SupervisorAttributes:
type: object
required:
- osuId
- positionNumber
additionalProperties: false
properties:
osuId:
type: string
nullable: true
description: OSU ID of the supervisor for the job.
pattern: ^\d{9}$
firstName:
type: string
nullable: true
description: First name of the supervisor for the job.
example: John
lastName:
type: string
nullable: true
description: Last name of the supervisor for the job.
example: Smith
email:
type: string
format: email
nullable: true
description: The primary email of the supervisor for the job.
example: john.smith@example.com
positionNumber:
type: string
nullable: true
description: Position number for the supervisor.
example: C12345
suffix:
type: string
nullable: true
description: Suffix of the supervisor.
JobPostRequired:
type: object
required:
- positionNumber
- studentEmployeeInd
- beginDate
- supervisor
- effectiveDate
properties: