Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
The following is the list of default List of Values or ENUMS that are supported with SDS v1, SDS v2.1 CSV or OneRoster API Inbound flows.
Organization Types
Source File / API Endpoint | orgs.csv | /orgs |
Source Field | type | type |
Destination Data Lake Table | Organization | Organization |
Destination Data Lake Field | RefOrganizationTypeId | RefOrganizationTypeId |
Default values supported below
Values | ||
---|---|---|
school | ministryOfEducation | localAuthority |
department | university | region |
district | college | division |
local | campus | province |
state | adultEducation | researchCenter |
national | municipality | program |
departmentOfEducation | academicTrust |
Organization user roles
Source file/API endpoint | roles.csv | /users |
Source field | role | role |
Destination data lake table | PersonOrganizationRole | PersonOrganizationRole |
Destination data lake field | RefRoleId | RefRoleId |
Default values supported below
Values | Sort order | Default role group |
---|---|---|
principal | 10 | Staff |
chair | 20 | Staff |
professor | 30 | Staff |
researcher | 40 | Staff |
adjunct | 50 | Staff |
affiliate | 60 | Staff |
occupationalTherapist | 70 | Staff |
physicalTherapist | 80 | Staff |
speechTherapist | 90 | Staff |
visionTherapist | 100 | Staff |
paraprofessional | 110 | Staff |
specialServices | 120 | Staff |
advisor | 130 | Staff |
proctor | 140 | Staff |
nurse | 150 | Staff |
officeStaff | 160 | Staff |
lecturer | 170 | Staff |
itAdmin | 180 | Staff |
administrator | 190 | Staff |
teacher | 200 | Staff |
faculty | 210 | Staff |
staff | 220 | Staff |
teacherAssistant | 230 | Staff |
assistant | 240 | Staff |
instructor | 250 | Staff |
substitute | 260 | Staff |
coach | 270 | Staff |
alumni | 280 | Staff |
student | Student | |
other | ||
Grade levels
Source file/API endpoint | roles.csv | student.csv | teacher.csv | courses.csv |
Source field | grade | Grade | Grade | grade |
Destination data lake table | PersonOrganizationRole | PersonOrganizationRole | PersonOrganizationRole | CourseGradeLevel |
Destination data lake field | RefGradeLevelId | RefGradeLevelId | RefGradeLevelId | RefGradeLevelId |
Source file/API endpoint | /users | /courses | /classes | courses.csv |
Source field | grades | grade | grade | grade |
Destination data lake table | PersonOrganizationRole | CourseGradeLevel | SectionGradeLevel | CourseGradeLevel |
Destination data lake field | RefGradeLevelId | RefGradeLevelId | RefGradeLevelId | RefGradeLevelId |
Default values supported below
Values | |
---|---|
it | Infant/toddler |
pr | Preschool |
pk | Prekindergarten |
tk | Transitional Kindergarten |
kg | Kindergarten |
'01' or'1' | First grade |
'02' or '2' | Second grade |
'03' or '3' | Third grade |
'04' or '4' | Fourth grade |
'05' or '5' | Fifth grade |
'06' or '6' | Sixth grade |
'07' or '7' | Seventh grade |
'08' or '8' | Eighth grade |
'09' or '9' | Ninth grade |
10 | Tenth grade |
11 | Eleventh grade |
12 | Twelfth grade |
13 | Grade 13 |
14 | Grade 14 |
ps | Postsecondary |
ug | Ungraded |
other | Other |
ps1 | Postsecondary freshman |
ps2 | Postsecondary sophomore |
ps3 | Postsecondary junior |
ps4 | Postsecondary senior |
undergraduate | undergraduate |
graduate | graduate |
postgraduate alumni | Graduate with an emphasis on research alumni |
adultEducation | Adult Education |
Academic session types
Source file/API endpoint | academicSessions.csv | /academicSessions |
Source field | type | type |
Destination data lake table | Session | Session |
Destination data lake field | RefSessionTypeId | RefSessionTypeId |
Default values supported below
Values | ||
---|---|---|
schoolYear | semester | term |
gradingPeriod | quarter |
Academic sessions school year
Source file/ API endpoint | academicSessions.csv | /academicSessions |
Source field | schoolYear | schoolYear |
Destination data lake table | Session | Session |
Destination data lake field | RefAcademicYearId | RefAcademicYearId |
Default values supported below
Values | ||
---|---|---|
2022 | 2026 | 2030 |
2023 | 2027 | 2031 |
2024 | 2028 | |
2025 | 2029 |
Contact Relationship roles
Source file/ API endpoint | relationships.csv | /users |
Source field | relationshipRole | role (for a student's agent's user record) |
Destination data lake table | PersonRelationship | PersonRelationship |
Destination data lake field | RefPersonRelationshipId | RefPersonRelationshipId |
Default values supported below
Values | |
---|---|
parent | guardian |
relative | other |
doctor | aide |
Enrollment roles
Source file/ API endpoint | enrollments.csv | /enrollments |
Source field | role | role |
Destination data lake table | Enrollment | Enrollment |
Destination data lake field | RefSectionRoleId | RefSectionRoleId |
Default values supported below
Values | ||
---|---|---|
student | visionTherapist | substitute |
aid | paraprofessional | principal |
proctor | teacherAssistant | specialServices |
teacher | professor | advisor |
administrator | lecturer | coach |
occupationalTherapist | affiliate | assistant |
physicalTherapist | adjunct | staff |
speechTherapist | instructor | alumni |
chair | itAdmin | officeStaff |
Person flags
Source file/ API endpoint | userFlags.csv | /users |
Source field | Flags [] | metadata (where metadata microsoft.userFlags = {value}) |
Destination data lake table | PersonDemographicPersonFlag | PersonDemographicPersonFlag |
Destination data lake field | RefPersonFlagId | RefPersonFlagId |
Default values supported below
Values | Description |
---|---|
freeLunch | Free lunch |
reducedLunch | Reduced lunch |
homeless | Homeless |
giftOrTalented | Gifted or talented |
504 | Section 504 placement |
ell | English language learner |
lep | Limited English proficiency |
iep | Special education services/ Independent education plan eligible |
Subjects
Source file/API endpoint | courses.csv | section.csv | /courses | /classes |
Source field | subject | Course Subject | subjectCodes | subjectCodes |
Destination data lake table | CourseSubject | CourseSubject | CourseSubject | SectionSubject |
Destination data lake field | RefAcademicSubjectId | RefAcademicSubjectId | RefAcademicSubjectId | RefAcademicSubjectId |
Default values supported below
Values | Description |
---|---|
'01' or '51037' | English language and literature |
'02' or '52039' | Mathematics |
'03' or '51999' | Life and physical sciences |
'04' or '54999' | Social sciences and history |
'05' or '55199' | Visual and performing arts |
'07' or '57999' | Religious education and theology |
'08' or '58999' | Physical, health, and safety education |
'09' or '09999' | Military science |
'10' or '10999' | Information technology |
'11' or '11999' | Communication and audio/video technology |
'12' or '62999' | Business and marketing |
'13' or '13999' | Manufacturing |
'14' or '14999' | Health care sciences |
'15' or '65999' | Public, protective, and government service |
'16' or '66999' | Hospitality and tourism |
'17' or '67997' | Architecture and construction |
'18' or '68999' | Agriculture, food, and natural resources |
'19' or '69001' | Human services |
'20' or '70999' | Transportation, distribution, and logistics |
'21' or '71999' | Engineering and technology |
'22' or '22999' | Miscellaneous |
'23' or '72999' | Non-subject-specific |
'24' or '24039' | World language |
Demographic ethnicity
Source file/ API endpoint | demographics.csv | /demographics |
Source field | ethnicity | hispanicOrLatinoEthnicity |
Destination data lake table | PersonDemographicEthnicity | PersonDemographicEthnicity |
Destination data lake field | RefEthnicityId | RefEthnicityId |
Default values supported below
Values | Description |
---|---|
hispanicOrLatinoEthnicity | Hispanic or Latino ethnicity |
Demographic race
Demographic race | |||
---|---|---|---|
Source file/ API endpoint | demographics.csv | ||
Source field | race [] | ||
Destination data lake table | PersonDemographicRace | ||
Destination data lake field | RefRaceId |
Demographic race | ||
---|---|---|
Source file/ API endpoint | /demographics | /demographics |
Source field | americanIndianOrAlaskaNative | asian |
Destination data lake table | PersonDemographicRace | PersonDemographicRace |
Destination data lake field | RefRaceId | RefRaceId |
Demographic race | ||
---|---|---|
Source file/ API endpoint | /demographics | /demographics |
Source field | blackOrAfricanAmerican | nativeHawaiianOrOtherPacificIslander |
Destination data lake table | PersonDemographicRace | PersonDemographicRace |
Destination data lake field | RefRaceId | RefRaceId |
Demographic race | ||
---|---|---|
Source file/ API endpoint | /demographics | /demographics |
Source field | white | demographicRaceTwoOrMoreRace |
Destination data lake table | PersonDemographicRace | PersonDemographicRace |
Destination data lake field | RefRaceId | RefRaceId |
Default values supported below
Values | Description |
---|---|
americanIndianOrAlaskaNative | American Indian or Alaska Native |
nativeHawaiianOrOtherPacificIslander | Native Hawaiian or other Pacific Islander |
blackOrAfricanAmerican | Black or African American |
demographicRaceTwoOrMoreRaces | Designates multiple races |
asian | Asian |
white | White |
Demographic gender
Source file/ API endpoint | demographics.csv | /demographics |
Source field | sex | sex |
Destination data lake table | PersonDemographic | PersonDemographic |
Destination data lake field | RefSexId | RefSexId |
Default values supported below
Values | ||
---|---|---|
male | female | notSelected |
Demographic birth state
Source file/ API endpoint | demographics.csv | /demographics |
Source field | birthState | stateofBirthAbbreviation |
Destination data lake table | PersonDemographic | PersonDemographic |
Destination data lake field | BirthState | BirthState |
Default values supported below
Values | ||
---|---|---|
AK | LA | OR |
AL | MA | PA |
AR | MD | PR |
AS | ME | PW |
AZ | MH | RI |
CA | MI | SC |
CO | MN | SD |
CT | MO | TN |
DC | MP | TX |
DE | MS | UT |
FL | MT | VA |
FM | NC | VI |
GA | ND | VT |
GU | NE | WA |
HI | NH | WI |
IA | NJ | WV |
IL | NV | AA |
IN | NY | AE |
KS | OH | AP |
KY | OK |