-
Notifications
You must be signed in to change notification settings - Fork 9
/
schema.graphql
3251 lines (2406 loc) · 84.4 KB
/
schema.graphql
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
# About the API
type About {
applicationName: String
applicationVersion: String
name: String
version: String
}
# Academic Credential
type AcademicCredential {
# A global identifier for an academic degree.
id: ID
# An abbreviation used to identify a degree (STVDEGC).
abbreviation: String
# The full name of an academic degree.
title: String
# The type of a degree such as 'degree', 'honorary', 'diploma', 'certificate' (GORSDAV).
type: String
# A full description of an academic degree (GORSDAV).
description: String
}
# Academic Discipline
type AcademicDiscipline {
# A global identifier for an academic discipline.
id: ID
# An abbreviation that identifies an academic discipline (STVMAJR).
abbreviation: String
# The full name of an academic discipline.
title: String
# A type of academic discipline such as 'minor', 'major' and 'concentration'.
type: String
# Reporting
reporting: [AcademicDisciplineReportingDetails]
}
# ReportingDetails
type AcademicDisciplineReportingDetails {
# The ISO 3166 alpha-3 country code for the United States of America.
countryCode: String
# The discipline code in the Classification of Instructional Programs (CIP).
cipCode: String
}
# Academic Honor
type AcademicHonor {
# A global identifier for an academic honor.
id: ID
# A code used to identify a honors (STVHONR_CODE and STVHOND_CODE).
code: String
# The type of an academic honor such as 'award', 'distinction'.
type: String
# The full name of an academic honor (STVHONR_DESC and STVHOND_DESC).
title: String
}
# Academic Level
type AcademicLevel {
# A globally unique identifier of the academic level.
id: ID
# The code that identifies the academic level (e.g. 'UG').
code: String
# The full name of the academic level (e.g. 'Undergraduate').
title: String
}
# Academic Period
type AcademicPeriod {
# A global identifier of an academic time period.
id: ID
# A term within an academic year, such as a Semester.
type: String
# A global identifier of an academic year.
parentId: ID
# The academic year in which term occurs.
parent: AcademicPeriod
# A code that identifies an academic time period.
code: String
# The full name of an academic time period (e.g. 'Fall 2014').
title: String
# The date at which the period ends
endOn: String
startOn: String
}
# Academic Period Enrollment Status
type AcademicPeriodEnrollmentStatus {
# A global identifier of a enrollment status (STVESTS_GUID).
id: ID
# A code that identifies a enrollment status (STVESTS_CODE).
code: String
# The full name of a enrollment status (STVESTS_DESC).
title: String
}
# Academic Program
type AcademicProgram {
# The global identifier of an academic program
id: ID
# The full name of an academic program
title: String
# A code that identifies an academic program
code: String
# List of Sites
sites: [Site]
# The global identifier of the level of academic progress that is associated with an academic program
academicLevelId: ID
# The level of academic progress that is associated with an academic program
academicLevel: AcademicLevel
# List of Credentials
credentials: [AcademicCredential]
# The status of an academic program
status: String
startOn: String
}
# Academic Standing
type AcademicStandingType {
# A global identifier of a academic standing (STVASTD_GUID).
id: ID
# A code that identifies a academic standing (STVASTD_CODE).
code: String
# The full name of a academic standing (STVASTD_DESC).
title: String
}
# Academic Year
type AcademicYear {
# The Surrogate Id of the STVACYR table
id: ID
# Code value to identify the academic year to which this term code is assigned
code: String
# Description of the academic year associated with the academic year code
description: String
# Optimistic lock token
version: String
}
# Address
type Address {
# The global identifier of the Address (SPRADDR, SOBSBGI)
id: ID
# The address lines of the address, such as a street address, post office box number, or city, region, and postal code
addressLines: [String]
# Place
place: Place
# The latitude of the location
latitude: String
# The longitude of the location
longitude: String
# List of Geographic Areas
geographicAreas: [GeographicArea]
}
# Address Type
type AddressType {
# A globally unique identifier of an address type.
id: ID
# The generally unique code for an address type (STVATYP_CODE).
code: String
# The full name of an address type (STVATYP_DESC).
title: String
# A mapping to a standard type for the address type.
addressType: String
}
# Authentication Token
type AuthenticationToken {
# JSON Web Token
token: String
# Expiration
expires: String
}
# Building
type Building {
# A global identifier of a building to be used in all external references to the building(SLBBLDG).
id: ID
# A code that identifies a building.
code: String
# The full name of the building.
title: String
# The global identifier for Site (STVCAMP).
siteId: ID
# Site
site: Site
}
# Campus Involvement
type CampusInvolvement {
# The global identifier of the campus involvements resource (SGRSACT, SGRSPRT and SHRCOMM)
id: ID
person: Person
# The id of the student who is involved in the organization.
personId: ID
campusOrganization: CampusOrganization
# The organization in the campus the student is involved with. The id of the campus-organizations resource
campusOrganizationId: ID
# The involvement to the organization started on
startOn: String
# The involvement to the organization ended on
endOn: String
academicPeriod: AcademicPeriod
# Academic period in which the student was involved in this organization. The id of the academic-periods resource
academicPeriodId: ID
role: CampusInvolvementRole
# Role of the student in the organization. The id of the campus-involvement-roles resource
roleId: ID
}
# Campus Involvement Role
type CampusInvolvementRole {
# The global identifier of the campus involvement roles resource
id: ID
# The full name of the campus involvement roles (STVCOMF_DESC).
title: String
# Code of the role of a persons involvement in an organization (STVCOMF_CODE).
code: String
# The description of the campus involvement roles (N/A in Banner).
description: String
}
# Campus Organization
type CampusOrganization {
# The global identifier of the campus organizations resource (STVACTC and STVCOMT)
id: ID
# The code that identifies the campus organization.
code: String
# The full name of the campus organization.
name: String
# Type of the organizations (eg: athletic, culture)
type: String
# Parent organization to which the campus organization comes under. From Banner
# perspective, there is no parent organization defined in this model at this
# time hence this property will not be present in the response
parentOrganization: String
}
# Campus Organization Type
type CampusOrganizationType {
# The global identifier of the campus organization types resource
id: ID
# The code that identifies the campus organization type ex: Athletic, Cultural (STVACTP_CODE).
code: String
# The full name of the campus organization type (STVACTP_DESC).
title: String
# The description of the campus organization type (N/A in Banner).
description: String
}
# Citizenship Status
type CitizenshipStatus {
# The globally unique identifier of a citizenship status
id: ID
# A global category of citizenship statuses (enum values- 'citizen', 'nonCitizen')
category: String
# The code that identifies a citizenship status (e.g. 'UK')
code: String
# The full name of a citizenship status (e.g. 'UK Citizen')
title: String
}
# Class
type Class {
# Code value to identify the academic year to which this term code is assigned
academicYear: String
# Description of the academic year associated with the academic year code
academicYearDescription: String
# Field that identifies part-of-term end date(yyyy-MM-dd)
completionDate: String
# Field that identifies the course number associated with the CRN
courseNumber: String
# Field that identifies the course reference number associated with the class section
courseReferenceNumber: String
# Course Registration Status
courseRegistrationStatus: CourseRegistrationStatus
# Course Title
courseTitle: String
# Field that identifies the credit hours associated with the CRN
creditHour: String
# List of Faculty
faculty: [Faculty]
# Field that identifies grading mode code for the section
gradingMode: String
# Field that identifies the grading mode associated with the grading mode code
gradingModeDescription: String
# Field that identifies the instructional method code assigned to the section
instructionalMethod: String
# Field that identifies the instructional method associated with the instructional method code
instructionalMethodDescription: String
# Field that identifies the continuing education indicator
ceuInd: Boolean
# List of Meeting Times
meetingTimes: [MeetingTime]
# Code value to identify the part-of-term for the base part-of-term
partOfTerm: String
# Description of the part-of-term associated with the part-of-term code
partOfTermDescription: String
# Field that identifies the schedule type associated with the schedule type code
scheduleDescription: String
# Field that identifies instructional type code of the section being scheduled
scheduleType: String
# Field that identifies the section number of a course
sequenceNumber: String
# Field that identifies the part-of-term start date(yyyy-MM-dd)
startDate: String
# Field that identifies the subject associated with the CRN
subject: String
# Description of the subject code
subjectDescription: String
# Code value to identify the term
term: String
# Description of the term associated with the term code
termDescription: String
}
# Class Format Details
type ClassFormatDetail {
# Field that identifies instructional type code of the section being scheduled
code: String
# Field that identifies the schedule type associated with the schedule type code
description: String
}
# Class Schedules
type ClassSchedules {
# Lists of Classes
studentCourseRegistrations: [Class]
# Field that identifies the sum of all bill hours registered for the courses in the given term
totalBill: String
# Field that identifies the sum of all credit hours registered for the continuous educational courses in the given term
totalCeu: String
# Field that identifies the sum of all credit hours registered for the courses other then CEU in the given term
totalCredit: String
}
# Country
type Country {
# The ISO 3166-1 alpha-3 country code
code: String
# The name of the country, as used in everyday speech
title: String
# The name of the country when mail is being addressed from an international sender
postalTitle: String
# Region
region: Region
# Sub-Region
subRegion: SubRegion
# The name of the city or town
locality: String
# The mailing postal code
postalCode: String
# A specific set of digits between 00 and 99 assigned to every address. When
# combined with the ZIP + 4 code, the delivery point provides a unique
# identifier for every deliverable address served by the US Postal Service
deliveryPoint: String
# A subdivision of a US zipcode
carrierRoute: String
# A number used to check for errors in a US ZIP code, delivery point, or carrier route
correctionDigit: String
}
# Country Details
type CountryDetails {
# The code of country (USA)
code: String
# The global category of ethnic origin to which a person belongs. Valid values are nonHispanic, hispanic
ethnicCategory: String
}
# Course
type Course {
# Globally-unique identifier of the course
id: String
# Course number
number: String
# Course title
title: String
# The starting date at which a Course is avalaible to have Sections scheduled to
# be taken. When combined with the scheduling ending date, defines the time
# period a Course is available for scheduling
schedulingStartOn: String
# The ending date at which a Course is no longer available to have Sections
# scheduled to be taken. When combined with the scheduling start date, defines
# the time period a Course is available for scheduling
schedulingEndOn: String
# Globally-unique identifier of subject (STVSUBJ)
subjectId: String
# Subject
subject: Subject
# List of Owning Institution Units
owningInstitutionUnits: [OwningInstitutionUnit]
# List of Academic Levels
academicLevels: [AcademicLevel]
# List of Grade Schemes
gradeSchemes: [GradeScheme]
# List of Instructional Methods
instructionalMethods: [InstructionalMethod]
# List of Credits
credits: [Credit]
}
# Course Registration Status
type CourseRegistrationStatus {
# Field that identifies the course registration status associated with the CRN
code: String
# Description of the course registration status code
description: String
}
# Allowed values for sort parameter
enum CoursesSort {
number
title
schedulingStartOn
schedulingEndOn
}
# Credential
type Credential {
# The type of credential, such as 'Person ID', 'Organization ID', 'System ID', etc.
type: String
# The current value of the credential.
value: String
# The date when the credential starts being valid.
startOn: String
# The date when the credential stops being valid.
endOn: String
}
# Credit
type Credit {
# Credit Category
creditCategory: CreditCategory
# It is the multiple by which a numeric range of values can be stepped from the minimum to the maximum (not used in Banner)
increment: Int
# A unit or standard of measurement (not used in Banner)
measure: String
# Minimum number of credit hours for which a course may be offered
minimum: Int
# Maximum number of credit hours for which a course may be offered
maximum: Int
}
# Credit Category
type CreditCategory {
# A global identifier of a credit category.
id: ID
# A human readable reference code to identify a particular credit category.
code: String
# The title of credit category.
title: String
# A description of the substance and nature of a credit category.
description: String
# The higher-level category of academic credits.
creditType: String
}
# Educational Institution
type EducationalInstitution {
# The global identifier of the institution
id: ID
# The full name of the institution from tables STVSBGI, GUBINST
title: String
# The type of the institution
type: String
# Indicates if this is a 'home' or 'external' institution'
homeInstitution: String
# List of Addresses
addresses: [Address]
}
# Educational Institution Unit
type EducationalInstitutionUnit {
# The global identifier of the educational institution unit
id: ID
# The full name of the unit
title: String
# The type of the unit (e.g., college, division, department, etc.)
type: String
# The global identifier for the Institution
parentInstitutionId: ID
# Parent Institution
parentInstitution: EducationalInstitution
}
# Email
type Email {
# An email address for the person.
address: String
# Specifies if the email is preferred over others of the same type or overall.
# Only one email should be set to primary for a person.
preference: String
# Email Type
emailType: EmailType
# The global identifier for the Email Type.
emailTypeId: ID
# A mapping to a standard type for the email type.
emailTypeCode: String
}
# Email Type
type EmailType {
# A globally unique identifier of an email type.
id: ID
# The generally unique code of an email type (GTVEMAL_CODE).
code: String
# The full name of an email type (GTVEMAL_DESC).
title: String
# A mapping to a standard type for the email type.
emailType: String
}
# Enrollment Status
type EnrollmentStatus {
# The global identifier of an enrollment status for use in all external references to an enrollment status (GORGUID).
id: ID
# The human-readable code that identifies an enrollment status (SOBCACT).
code: String
# The status of the enrollment such as 'active','inactive' and 'complete'.
status: String
# The full name of an enrollment status (STVCACT).
title: String
}
# Ethnicity
type Ethnicity {
# Globally-unique identifier of the new ethnicity defined by U.S government. The
# valid values are Not Hispanic and Hispanic (GORGUID_GUID)
id: ID
# The ethnic code defined by the U.S. government. Valid values are Hispanic or Latino, Not Hispanic or Latino
title: String
# Reporting
reporting: ReportingDetails
}
# External Education
type ExternalEducation {
# The global identifier of the external education from SORHSCH/SORPCOL/SORDEGR/SHRTRIT/SHRTRAM tables
id: ID
# The global identifier for the Person who was educated at the institution
personId: ID
# Person Record
person: Person
# The global identifier for the Institution where the person studied
institutionId: ID
# Institution
institution: EducationalInstitution
# The global identifier for the Credential (degree, diploma, etc.) the person was awarded at the institution
credentialId: String
# Credential
credential: AcademicCredential
# List of Disciplines
disciplines: [AcademicDiscipline]
# The date when the person's education at the institution began
startOn: String
# The date when the person's education at the institution ended
endOn: String
# A measurement of the student's educational performance at the institution (e.g. GPA)
performanceMeasure: String
# The date the student graduated from the institution
graduatedOn: String
# The date when the institution awarded a credential (e.g. degree) to the person
credentialsDate: String
# The date that the transcript for the student's education was received
transcriptReceivedOn: String
# The size of the class associate with the person's course of study
classSize: Int
# The person's class percentile
classPercentile: Int
# The person's class rank
classRank: Int
}
# Faculty
type Faculty {
# The identification number used to access a person
bannerId: String
# Field that identifies Instructor's display name
displayName: String
# Field that identifies Instructor's email address
emailAddress: String
# Field that identifies Instructor's primary indicator
primaryIndicator: Boolean
# Person identification record for Instructor
personIdentification: PersonIdentification
# Schedule for Instructor
schedule: [Class]
}
# Faculty Advisor
type FacultyAdvisor {
# The identification number used to access a person
bannerId: ID
# Returns true if advisor
advisor: Boolean
# Returns true if faculty
faculty: Boolean
# Person's first name
firstName: String
# Person's last name
lastName: String
# Person's middle name
middleName: String
}
# Geographic Area
type GeographicArea {
# The global identifier of a geographic area(GORGUID).
id: ID
# The code of the area(STVGEOR_CODE-STVGEOD_CODE).
code: String
# The full name of a geographic area (STVGEOR_DESC-STVGEOD_DESC).
title: String
# A category of geographic area type such as 'governmental', 'postal', 'recruitment', 'institutional' and 'fundraising'.
category: String
# The global identifier for the Geographic Area Type.
typeId: ID
# Geographic Area Type
type: GeographicAreaType
# List of Included Areas
includedAreas: [GeographicArea]
}
# Geographic Area Type
type GeographicAreaType {
# The global identifier of a geographic area type(GORGUID).
id: ID
# The code of the geographic area type (STVGEOR_CODE or STVGEOD_CODE)
code: String
# The full name of a geographic area type (STVGEOR_DESC or STVGEOD_DESC).
title: String
# A category of geographic area type such as 'governmental', 'postal', 'recruitment', 'institutional' and 'fundraising'.
category: String
# The description of a geographic area type.
description: String
}
# Grade Change Reason
type GradeChangeReason {
# Globally-unique identifier of the grade change reason (STVGCHG)
id: ID
# The code that identifies the grade change reason (e.g. 'OE')
code: String
# The full name of a grade change reason (e.g. 'Original Entry')
title: String
}
# Grade Definition
type GradeDefinition {
# The global identifier of the grade (SHRGDID_GUID).
id: ID
# The type of the grade.Valid type is literal.
type: String
# The literal value of the grade (SHRGDID_GRADE).
value: String
# The global identifier for Grade Scheme (SHRGDID_GRADE_SCHEME).
schemeId: ID
# Grade Scheme
scheme: GradeScheme
}
# Grade Mode
type GradeMode {
# The global identifier of the grade modes.
id: ID
# The code associated with the grade mode(STVGMOD).
code: String
# The full name of the grade modes.
title: String
}
# Grade Scheme
type GradeScheme {
# A global identifier of a grade scheme (SHRGSCH_GUID).
id: ID
# The code for the grade scheme that may be used a reference or for reporting(SHRGSCH_GRADE_SCHEME_CODE).
code: String
# The full name of a grade scheme.
title: String
# The global identifier for the Academic Level.
academicLevelId: ID
# Academic Level
academicLevel: AcademicLevel
# The global identifier for the Grade Mode.
gradeModeId: ID
# Grade Mode
gradeMode: GradeMode
}
# Retrieves the availability status of the Student API application deployed.
type HealthCheck {
# Student API application’s status information
status: String
}
# Instructional Event
type InstructionalEvent {
# Globally-unique identifier of the instructional-event
id: ID
# Globally unique identifier of the section (SSBSECT)
sectionId: String
# Globally-unique identifier of instructional method (STVSCHD)
instructionalMethodId: String
# Instructional Method
instructionalMethod: InstructionalMethod
# Faculty workload assignment
workLoad: Int
}
# Instructional Method
type InstructionalMethod {
# A global identifier of an instructional method to be used in all external references.
id: ID
# Human readable abbreviated name to an instructional method.
abbreviation: String
# The full name of an instructional method
title: String
}
# Instructional Platform
type InstructionalPlatform {
# A global identifier of an instructional platform to be used in all external references(GORINTG).
id: ID
# Human readable code that identifies a technology platform.
code: String
# The full name of a technology platform.
title: String
}
# Instructor
type Instructor {
# The global identifier of the instructor.
id: ID
# The global identifier for the Primary Location.
primaryLocationId: ID
# Primary Location
primaryLocation: Room
# The global identifier for the Category.
categoryId: ID
# Instructor Category
category: InstructorCategory
# The global identifier for the Staff Type.
staffTypeId: ID
# Instructor Staff Type
staffType: InstructorStaffType
tenure: InstructorTenure
}
# Instructor Category
type InstructorCategory {
# The global identifier of the instructor category.
id: ID
# The full name of the instructor category.
title: String
# A code that may be used to identify the instructor category.
code: String
}
# Instructor Staff Type
type InstructorStaffType {
# The global identifier of the instructor staff type.
id: ID
# The full name of the instructor staff type.
title: String
# A code that may be used to identify the instructor staff type.
code: String
}
# Instructor Tenure
type InstructorTenure {
# The global identifier of the instructor tenure type.
typeId: ID
# Instructor Tenure Type
type: InstructorTenureType
# The date when tenure was awarded to the instructor.
startOn: String
# The date the instructor was last reviewed for tenure.
reviewedOn: String
}
# Instructor Tenure Type