OneRoster Data Dictionary
Most of the OneRoster model definitions are self explanatory. Some are implementation dependent, and metadata access requires specific scope grants. The following table details specific implementation details, the originating eSchoolPlus (SMS) field, and scope grant requirements.
The eSchool Source column below names the eSchoolPlus table and column (or screen / field number for user-defined screens) that is the system of record for each OneRoster field. Values shown as derived are computed during transformation (for example, OneRoster subject and grade are inferred from the 6-digit State Course Code), and a few fields (such as ATLAS indicators) originate from non-eSchool feeds.
| Model | Field | Meaning / Notes | Scope Required | eSchool Source (table.column) |
|---|---|---|---|---|
| Org (district) | name | Official State Name | reg_district.name | |
| Org (school) | name | Official State Name | reg_building.name | |
| Org (district) | identifier | Official Arkansas LEA | ADE-assigned district LEA (7-digit) | |
| Org (school) | identifier | Official Arkansas LEA | reg_building.state_code_equiv | |
| Org | metadata.addr1 | Address 1 | https://oneroster.triand.com/orgs-metadata.readonly | reg_building.street1 |
| Org | metadata.addr2 | Address 2 | https://oneroster.triand.com/orgs-metadata.readonly | reg_building.street2 |
| Org | metadata.city | City | https://oneroster.triand.com/orgs-metadata.readonly | reg_building.city |
| Org | metadata.state | US State | https://oneroster.triand.com/orgs-metadata.readonly | reg_building.state |
| Org | metadata.country | Country | https://oneroster.triand.com/orgs-metadata.readonly | constant "USA" |
| Org | metadata.zip | ZipCode | https://oneroster.triand.com/orgs-metadata.readonly | reg_building.zip |
| Org | metadata.phone | Phone | https://oneroster.triand.com/orgs-metadata.readonly | reg_building.phone |
| Org | metadata.gradeLow | Grade Low | https://oneroster.triand.com/orgs-metadata.readonly | derived from mr_class_size grades served |
| Org | metadata.gradeHigh | Grade High | https://oneroster.triand.com/orgs-metadata.readonly | derived from mr_class_size grades served |
| Org | metadata.principalName | Principal Name | https://oneroster.triand.com/orgs-metadata.readonly | reg_building.principal |
| Org | metadata.principalSourcedId | Principal SourcedId | https://oneroster.triand.com/orgs-metadata.readonly | reg_staff.staff_state_id (building principal) |
| User (student) | username | District Local-ID | reg.student_id | |
| User (student) | givenName | First name | reg.first_name | |
| User (student) | familyName | Last name | reg.last_name | |
| User (student) | middleName | Middle name | reg.middle_name | |
| User (student) | role | constant "student" | n/a | |
| User (student) | identifier | State Student-ID (10-digit) | reg_personal.state_report_id | |
| User (student) | orgs | School SourcedId | reg.building → reg_building.state_code_equiv | |
| User (student) | grades | Grade level | reg.grade (ESI override: reg_user screen 5090 / field 3) | |
| User (student) | Student contact email | reg_contact.email | ||
| User (student) | agents | Guardian SourcedIds | reg_stu_contact (contact_type='G') | |
| User (student) | metadata.addr1 | Student Address 1 | https://oneroster.triand.com/students-metadata.readonly | reg_contact.street_number + street_name |
| User (student) | metadata.addr2 | Student Address 2 | https://oneroster.triand.com/students-metadata.readonly | reg_contact (apt/suite) |
| User (student) | metadata.city | Student City | https://oneroster.triand.com/students-metadata.readonly | reg_contact.city |
| User (student) | metadata.state | Student US State | https://oneroster.triand.com/students-metadata.readonly | reg_contact.state |
| User (student) | metadata.country | Student Country | https://oneroster.triand.com/students-metadata.readonly | constant "USA" |
| User (student) | metadata.zip | Student ZipCode | https://oneroster.triand.com/students-metadata.readonly | reg_contact.zip |
| User (student) | metadata.dob | Student Date of Birth | https://oneroster.triand.com/students-metadata.readonly | reg.birthdate |
| User (student) | metadata.localid | District Local-ID | https://oneroster.triand.com/students-metadata.readonly | reg.student_id |
| User (student) | metadata.primaryDistrictLea | Primary District LEA | https://oneroster.triand.com/students-metadata.readonly | reg_district LEA |
| User (teacher) | username | District Local-ID | reg_staff.staff_id | |
| User (teacher) | givenName | First name | reg_staff.first_name | |
| User (teacher) | familyName | Last name | reg_staff.last_name | |
| User (teacher) | role | constant "teacher" | n/a | |
| User (teacher) | identifier | State Educator-ID (10-digit) | reg_staff.staff_state_id | |
| User (teacher) | Teacher email | reg_staff.email | ||
| User (teacher) | orgs | Primary School SourcedId | reg_staff_bldgs.building (is_primary_bldg='Y') → reg_building.state_code_equiv | |
| User (guardian) | givenName | First name | reg_contact.first_name | |
| User (guardian) | familyName | Last name | reg_contact.last_name | |
| User (guardian) | role | constant "guardian" | n/a | |
| User (guardian) | Guardian Email | https://oneroster.triand.com/guardians-metadata.readonly | reg_contact.email | |
| User (guardian) | phone | Guardian phone | https://oneroster.triand.com/guardians-metadata.readonly | reg_contact_phone.phone |
| User (guardian) | agents | Linked student SourcedId | https://oneroster.triand.com/guardians-metadata.readonly | reg_stu_contact.student_id |
| User (guardian) | metadata.addr1 | Guardian Address 1 | https://oneroster.triand.com/guardians-metadata.readonly | reg_contact.street_number + street_name |
| User (guardian) | metadata.addr2 | Guardian Address 2 | https://oneroster.triand.com/guardians-metadata.readonly | reg_contact (apt/suite) |
| User (guardian) | metadata.city | Guardian City | https://oneroster.triand.com/guardians-metadata.readonly | reg_contact.city |
| User (guardian) | metadata.state | Guardian US State | https://oneroster.triand.com/guardians-metadata.readonly | reg_contact.state |
| User (guardian) | metadata.country | Guardian Country | https://oneroster.triand.com/guardians-metadata.readonly | constant "USA" |
| User (guardian) | metadata.zip | Guardian ZipCode | https://oneroster.triand.com/guardians-metadata.readonly | reg_contact.zip |
| User (guardian) | metadata.relationship | Guardian Relationship | https://oneroster.triand.com/guardians-metadata.readonly | reg_stu_contact.relation_code (regtb_relation.description) |
| User (guardian) | metadata.contactPriority | Guardian Contact Priority | https://oneroster.triand.com/guardians-metadata.readonly | reg_stu_contact.contact_priority |
| User (guardian) | metadata.langHome | Guardian Home Language | https://oneroster.triand.com/guardians-metadata.readonly | reg_contact.home_language |
| User (guardian) | metadata.langCorrespondance | Guardian Preferred Correspondance Language | https://oneroster.triand.com/guardians-metadata.readonly | reg_contact.language |
| Demographics | birthDate | Student Date of Birth | {{IMS version prefix}}/scope/roster-demographics.readonly | reg.birthdate |
| Demographics | americanIndianOrAlaskaNative | boolean | {{IMS version prefix}}/scope/roster-demographics.readonly | reg_ethnicity (ethnic_code 'I') / reg_personal.FED_RACE_ETHNIC |
| Demographics | asian | boolean | {{IMS version prefix}}/scope/roster-demographics.readonly | reg_ethnicity (ethnic_code 'A') |
| Demographics | blackOrAfricanAmerican | boolean | {{IMS version prefix}}/scope/roster-demographics.readonly | reg_ethnicity (ethnic_code 'B') |
| Demographics | nativeHawaiianOrOtherPacificIslander | boolean | {{IMS version prefix}}/scope/roster-demographics.readonly | reg_ethnicity (ethnic_code 'P') |
| Demographics | white | boolean | {{IMS version prefix}}/scope/roster-demographics.readonly | reg_ethnicity (ethnic_code 'W') |
| Demographics | hispanicOrLatinoEthnicity | boolean | {{IMS version prefix}}/scope/roster-demographics.readonly | reg_personal.hispanic |
| Demographics | sex | male / female | {{IMS version prefix}}/scope/roster-demographics.readonly | reg.gender |
| Demographics | metadata.mi | boolean - migrant | https://oneroster.triand.com/demographic-metadata.readonly | reg_personal.migrant |
| Demographics | metadata.ec | boolean - EconDis (true when value is 01, 02, 04, 05, 06) | https://oneroster.triand.com/demographic-metadata.readonly | reg_v_programs (state_code_equiv ARSES) |
| Demographics | metadata.hl | boolean - Homeless | https://oneroster.triand.com/demographic-metadata.readonly | reg_personal.homeless_status |
| Demographics | metadata.gi | boolean - Gifted and Talented | https://oneroster.triand.com/demographic-metadata.readonly | reg_v_programs (state_code_equiv ARGT) |
| Demographics | metadata.md | boolean - Parent in Military | https://oneroster.triand.com/demographic-metadata.readonly | reg_user screen 102 / field 26 |
| Demographics | metadata.s54 | boolean - Section 504 | https://oneroster.triand.com/demographic-metadata.readonly | reg_personal.section_504_plan |
| Demographics | metadata.iep | boolean - IEP | https://oneroster.triand.com/demographic-metadata.readonly | reg_v_programs (state_code_equiv ARSA) |
| Demographics | metadata.fosterChild | boolean - Foster Child | https://oneroster.triand.com/demographic-metadata.readonly | reg_stu_contact (contact_type='G', relation_code='T') |
| Demographics | metadata.singleParent | boolean - Single Parent | https://oneroster.triand.com/demographic-metadata.readonly | reg_user screen 102 / field 41 |
| Demographics | metadata.ell | boolean - English Language Learner | https://oneroster.triand.com/demographic-metadata.readonly | reg_v_programs (state_code_equiv ARELL) |
| Demographics | metadata.rael | boolean - Recently Arrived English Learner (true when code = 01) | https://oneroster.triand.com/demographic-metadata.readonly | reg_user screen 105 / field 6 |
| Demographics | metadata.raelCode | RAEL status code (raw value behind rael) | https://oneroster.triand.com/demographic-metadata.readonly | reg_user screen 105 / field 6 |
| Demographics | metadata.ethnicity | Federal Ethnicity | https://oneroster.triand.com/demographic-metadata.readonly | reg_personal.FED_RACE_ETHNIC |
| Demographics | metadata.esi | Primary disability | https://oneroster.triand.com/demographic-metadata.readonly | reg_user screen 5090 / field 16 |
| Demographics | metadata.esiDate | First ESI Eligibility Determined Date | https://oneroster.triand.com/demographic-metadata.readonly | reg_user screen 5090 / field 12 |
| Demographics | metadata.esiLast | Last ESI Eligibility Determined Date | https://oneroster.triand.com/demographic-metadata.readonly | reg_user screen 5090 / field 11 |
| Demographics | metadata.ap | Alternative Portfolio | https://oneroster.triand.com/demographic-metadata.readonly | reg_user screen 5090 / field 6 |
| Demographics | metadata.mealStatus | Meal Status (Free,Reduced,Full-price Paid,Direct Certification) | https://oneroster.triand.com/demographic-metadata.readonly | reg_v_programs (state_code_equiv ARSES) |
| Demographics | metadata.language | Native Language | https://oneroster.triand.com/demographic-metadata.readonly | reg.language |
| Demographics | metadata.atlasBottomQuartile | ATLAS bottom quartile indicator | https://oneroster.triand.com/demographic-metadata.readonly | ATLAS assessment feed (not from eSchool) |
| Demographics | metadata.atlasBottomQuartileOctober | ATLAS bottom quartile (October) | https://oneroster.triand.com/demographic-metadata.readonly | ATLAS assessment feed (not from eSchool) |
| Course | title | Course name | schd_ms.description | |
| Course | courseCode | State Course Code (6-digit) | schd_course state code (state_code_equiv) | |
| Course | org | School SourcedId | reg.building → reg_building.state_code_equiv | |
| Class | title | Course name | schd_ms.description | |
| Class | classCode | Local Course-ID | schd_ms.course | |
| Class | course | Course SourcedId | derived (Course key) | |
| Class | school | School SourcedId | reg_building.state_code_equiv | |
| Class | terms | AcademicSession SourcedId | schd_ms_mp.marking_period (reg_mp_weeks) | |
| Class | periods | Class period | schd_ms_session.start_period | |
| Class | subjects | OneRoster subject | derived from State Course Code | |
| Class | grades | Grade level(s) | derived from State Course Code | |
| Class | metadata.teacherFirst | Teacher first name | reg_staff.first_name (via schd_ms_session.primary_staff_id) | |
| Class | metadata.teacherLast | Teacher last name | reg_staff.last_name | |
| Class | metadata.teacherSourcedId | Teacher SourcedId | reg_staff.staff_state_id | |
| Enrollment (student) | user | Student SourcedId | reg_personal.state_report_id (via schd_stu_course) | |
| Enrollment (student) | role | constant "student" | n/a | |
| Enrollment (teacher) | user | Teacher SourcedId | reg_staff.staff_state_id (schd_ms_session.primary_staff_id) | |
| Enrollment (teacher) | role | constant "teacher" | n/a | |
| Enrollment | class | Class SourcedId | derived (Class key) | |
| Enrollment | school | School SourcedId | reg_building.state_code_equiv | |
| AcademicSession | schoolYear | SMS school year | reg_district.school_year | |
| AcademicSession | title / type (term) | FY / S1 / S2 | reg_mp_weeks (marking periods) | |
| AcademicSession | startDate / endDate | Term / grading-period dates | reg_mp_dates.start_date / end_date |
In the Scope Required column, {{IMS version prefix}} is https://purl.imsglobal.org/spec/or/v1p1 for OneRoster 1.1 or https://purl.imsglobal.org/spec/or/v1p2 for OneRoster 1.2.