This article provides information on how data in Aeries are mapped to OneRoster. These data elements are shared between the OneRoster API and the CSV extract.
Note: OneRoster extracts and OneRoster API calls require a current class enrollment record (ATT/ENR). Students not having current enrollment at the time the extract is created will not be included in the extract results
Academic Session
OneRoster Element | Aeries Field | Comment/Example |
---|---|---|
sourcedId | TRM.SC + "_" + TRM.TM | 994_F |
dateLastModified | TRM.DTS | Converted to UTC time |
title | Determined by TRM.TM and whether the school is semester or trimester | |
startDate | TRM.D1 | |
endDate | TRM.D2 | |
type | "term" | |
schoolYear | The current school year |
Class / Classes - Secondary (and elementary w/ MST)
OneRoster Element | Aeries Field | Comment/Example |
---|---|---|
sourcedId | MST.SC + "_" + MST.SE | 994_1001 |
dateLastModified | MST.DTS | Converted to UTC time |
title | CRS.CO | |
classType | "scheduled" or "homeroom". Homeroom applies only to elementary w/ MST | |
location | MST.RM | |
grades | MST.LO, MST.HI | Lists all grades from LO to HI. Ex: "09", "10", "11", "12" |
course | MST.CN | |
school | MST.SC | |
terms | MST.SC + "_" + MST.SM | 994_F |
periods | NonFlex MST.PD, MST.BL For Flex FTF.STI FTF.ST FTF.ET | Lists all periods in a block section. Ex: "2", "3", "4" |
Class / Classes - Elementary
OneRoster Element | Aeries Field | Comment/Example |
---|---|---|
sourcedId | TCH.SC + "_TN_" + TCH.TN (beginning 2019-2020) TCH.SC + "_" + TCH.ID (2018-2019 format) | 990_TN_421 (beginning in 2019-2020) 990_990421 (2018-2019 format) |
dateLastModified | STF.DTS | Converted to UTC time |
title | (blank) | |
classType | "scheduled" | |
location | TCH.RM | |
grades | TCH.LO, TCH.HI | Lists all grades from LO to HI. Ex: "KG", "01" |
course | "TCH_" + TCH.ID | TCH_990421 |
school | TCH.SC | |
terms | TCH.SC + "_Y | 990_Y |
periods | 0 |
Course - Secondary (and elementary w/ MST)
OneRoster Element | Aeries Field | Comment/Example |
---|---|---|
sourcedId | CRS.CN | |
dateLastModified | CRS.DTS | Converted to UTC time |
title | CRS.CO | |
courseCode | CRS.CN | |
grades | CRS.LO, CRS.HI | Lists all grades from LO to HI. Ex: "09", "10", "11", "12" |
Course - Elementary
OneRoster Element | Aeries Field | Comment/Example |
---|---|---|
sourcedId | "TCH_" + TCH.ID | TCH_990421 |
dateLastModified | TCH.DTS | Converted to UTC time |
title | TCH.TE | Acosta |
courseCode | "TCH_" + TCH.ID | |
grades | TCH.LO, TCH.HI | Lists all grades from LO to HI. Ex: "09", "10", "11", "12" |
Demographics
OneRoster Element | Aeries Field | Comment/Example |
---|---|---|
sourcedId | "STU_" + STU.ID | STU_99400001. Will use the custom sourcedId field (e.g., STU.NID) instead of STU.ID if configured. |
dateLastModified | STU.DTS | Converted to UTC time |
birthDate | STU.BD | |
sex | STU.GN | OneRoster only supports values of "male" and "female". Other gender values will be returned as null (API) or blank (CSV). |
americanIndianOrAlaskaNative | STU.RC1 - RC5 | |
asian | STU.RC1 - RC5 | |
blackOrAfricanAmerican | STU.RC1 - RC5 | |
nativeHawaiianOrOtherPacificIslander | STU.RC1 - RC5 | |
white | STU.RC1 - RC5 | |
demographicRaceTwoOrMoreRaces | false | |
hispanicOrLatinoEthnicity | STU.ETH | |
countryOfBirthCode | STU.BCU | |
stateOfBirthAbbreviation | STU.BST | |
cityOfBirth | STU.BCY |
Enrollment - Secondary (and elementary w/ MST) - Student
OneRoster Element | Aeries Field | Comment/Example |
---|---|---|
sourcedId | SEC.SC + "_STU_" + STU.ID + "_" + SEC.SE | 994_STU_99400001_1001 |
dateLastModified | SEC.DTS | Converted to UTC time |
user | See "User - Student" | STU_99400001 |
class | See "Class" | 994_1001 |
school | See "Org" | 994 |
role | "student" | |
primary | false | |
beginDate | CAR.DS | |
endDate | CAR.DE |
Enrollment - Secondary (and elementary w/ MST) - Teacher
OneRoster Element | Aeries Field | Comment/Example |
---|---|---|
sourcedId | For Non-Flex MST.SC + "_TCH_" + TCH.ID + "_" + MST.SE For FLEX/SSE MST.SC + "_TCH_" + STF.ID + "_" + MST.SE | 994_TCH_994005_1001 |
dateLastModified | SEC.DTS | Converted to UTC time |
user | See "User - Teacher" | TCH_994605 |
class | See "Class" | 994_1001 |
school | See "Org" | 994 |
role | "teacher" | |
primary | true |
Enrollment - Elementary - Student
OneRoster Element | Aeries Field | Comment/Example |
---|---|---|
sourcedId | STU.SC + "_STU_" + STU.ID + "_0" | 990_STU_99000007_0 |
dateLastModified | STU.DTS | Converted to UTC time |
user | See "User - Student" | STU_99000007 |
class | See "Class" | 990_990421 or 990_TN_421 |
school | See "Org" | 990 |
role | "student" | |
primary | false | |
beginDate | TRM.D1 | Uses the current term |
endDate | TRM.D2 | Uses the current term |
Enrollment - Elementary - Teacher
OneRoster Element | Aeries Field | Comment/Example |
---|---|---|
sourcedId | TCH.SC + "_TCH_" + TCH.ID + "_0" | 990_TCH_990421_0 |
dateLastModified | STU.DTS | Converted to UTC time |
user | See "User - Teacher" | TCH_990421 |
class | See "Class" | 990_990421 |
school | See "Org" | 990 |
role | "teacher" | |
primary | true |
Line Item
OneRoster Element | Aeries Field | Comment/Example |
---|---|---|
sourcedId | GBA.UI | |
dateLastModified | GBA.DTS | Converted to UTC time |
metadata.vendorId | GBA.EI | |
title | GBA.AD | |
description | GBA.COM | |
assignDate | GBA.DA | If GBA.DA is not populated, use GBA.DD Converted to UTC time |
dueDate | GBA.DD | Converted to UTC time |
class | See "Class". Based on GBE.SC and GBE.SE | |
category | See "Category". Based on GBA.GN and GBA.AT | |
gradingPeriod | See "Academic Session". Based on GBE.SC and GBR.CD | |
resultValueMin | 0 | |
resultValueMax | GBA.NP |
Category
OneRoster Element | Aeries Field | Comment/Example |
---|---|---|
sourcedId | GBT.GN + "_" + GBT.AT | 4366926_1 |
dateLastModified | GBT.DTS | Converted to UTC time |
metadata.classId | GBE.SC + "_" + GBE.SE | |
title | GBT.TD |
Org
OneRoster Element | Aeries Field | Comment/Example |
---|---|---|
sourcedId | LOC.CD | |
dateLastModified | LOC.DTS | Converted to UTC time |
name | LOC.NM | |
type | "district" or "school" | |
parent | For schools, this is a reference to the district (school 0) | |
children | For the district, this is a list of references to all schools |
Result
OneRoster Element | Aeries Field | Comment/Example |
---|---|---|
sourcedId | STU.SC + "_STU_" + STU.ID + "_" + GBA.UI | 994_STU_99400001_538f1dcf-ba96-4678-86fd-b7abcd43bb82 |
dateLastModified | GBS.DTS | Converted to UTC time |
lineItem | See "Line Item" | 538f1dcf-ba96-4678-86fd-b7abcd43bb82 |
student | See "User - Student" | STU_99400001 |
scoreStatus | Based on GBS.MK and GBA.GC | "exempt", "notsubmitted", "submitted", "fullygraded" |
score | GBS.NC | |
scoreDate | GBS.DC | |
comment | GBS.CO |
User - Student
OneRoster Element | Aeries Field | Comment/Example |
---|---|---|
sourcedId | "STU_" + STU.ID | STU_99400001. Will use a different sourcedId field (e.g., STU.NID) instead of STU.ID if configured. |
dateLastModified | STU.DTS | Converted to UTC time |
username | STU.SEM | Will use a different username field (e.g., STU.NID) if configured |
userIds | Uses the configured option for userIds. | |
enabledUser | true | |
givenName | STU.FN | |
familyName | STU.LN | |
middleName | STU.MN | |
role | "student" | |
identifier | STU.SC + "_STU_" + STU.ID | 994_STU_99400001 |
STU.SEM | ||
phone | STU.TL | |
agents | See "User - Parent" | List of references to parent accounts linked to this student |
orgs | STU.SC | List of all schools where this student is enrolled |
grades | STU.GR |
User - Teacher
OneRoster Element | Aeries Field | Comment/Example |
---|---|---|
sourcedId | "TCH_" + STF.ID | TCH_994605. Will use a different sourcedId field (e.g., STF.NID) instead of STF.ID if configured. |
dateLastModified | STF.DTS | Converted to UTC time |
username | TCH.EM | Will use a different username field (e.g., STF.NID) if configured |
userIds | Uses the configured option for userIds. | |
enabledUser | true | |
givenName | STF.FN | |
familyName | STF.LN | |
middleName | STF.MN | |
role | "teacher" | |
identifier | For Non Flex TCH.SC + "_TCH_" + STF.ID For Flex SSE.SC + "_TCH_" + STF.ID | 994_TCH_994605 |
STF.EM | ||
phone | STF.TL | |
orgs | TCH.SC | List of all schools where this teacher has a record |
grades | TCH.LO, TCH.HI | Lists all grades from LO to HI. Ex: "09", "10", "11", "12" This includes teacher grade levels when teaching at multiple schools. |
User - Parent
OneRoster Element | Aeries Field | Comment/Example |
---|---|---|
sourcedId | "PAT_" + PWA.AID | PAT_23 |
dateLastModified | PWA.DTS | Converted to UTC time |
username | PWA.EM | |
enabledUser | true | |
givenName | CON.FN | |
familyName | CON.LN | |
middleName | CON.MN | |
role | "parent" | |
identifier | "0_PAT_" + PWA.AID | 0_PAT_23 |
CON.EM | Use PWA.EM if CON.EM is not populated | |
sms | CON.CP | |
phone | CON.TL | |
agents | See "User - Student" | List of references to students linked to this parent account |
orgs | STU.SC | Displays as a 0 for parent accounts. |