OneRoster Troubleshooting (1.1)

This article provides some troubleshooting tips for users of the OneRoster API. OneRoster connections are managed the Digital Learning Partners tool. Review the OneRoster API article for introductory information about these connections.

How do I know the OneRoster connection is working on the Campus end? How do I know what data is being retrieved from Campus?

Use the REST Documentation Client to verify your Campus connection to the OneRoster API and show what data the API is collecting for various endpoints. The REST Doc Client also allows you to query specific data in OneRoster via the sourceId. 

The sourcedId is a key piece of data used to identify records. This value is usually the unique identifier for an element, such as the GUID. The following table provides the Campus database location and UI path of the sourcedId for each object:

ObjectCampus EquivalentCampus DatabaseCampus Path
Academic SessionsTerm ScheduleTerm.termID

Not shown in the UI

System Administration > Calendar > Calendar > Terms

ClassSectionSection.sectionIDScheduling > Course > Section > SectionID
CourseCourseCourse.courseIDScheduling > Courses > Course > CourseID
DemographicsIdentityIdentity.identityGUIDCensus > People > Identity > Person Identifiers > Person GUID
Enrollment
(Student)

Roster records

S + Roster.rosterID

For example: s1234567

Not shown in the UI

Scheduling > Course > Section > Roster

Enrollment (Teacher)Staff History records

T + SectionStaffHistory.historyID

For example: t123014

Not shown in the UI

Scheduling > Course > Section > Staff History (Role of Primary or Teacher)

Grading PeriodNot captured in Campus - placeholder created based on TermN/AN/A
Line ItemGrading Task/Standard and Section Term Mask

Section.sectionID +
Term.termID +
GradingTask.taskID

(no spaces)

Not shown in the UI

Scheduling > Courses > Grading Tasks, Standards

Line Item CategoryNot captured in Campus - always returns 00000000-0000-0000- 0000-000000000000N/AN/A
OrgDistrict or SchoolDistrict.districtGUID
School.schoolGUID

Not shown in the UI

System Administration > Resources > District Information
System Administration > Resources > School

ResultPosted GradesGradingScore. externalLMSSourcedIDNot shown in the UI - generated by the system of record (Campus or Vendor)
Score GroupScore Group or RubricScoreGroup.scoreGroupIDNot shown in the UI
TermTermChildren of Academic Sessions
Term.termID
Children of Academic Sessions
System Administration > Calendar > Calendar > Terms
UserPerson + role in Campus (student, staff, teacher)

Student: s + UserAccount.personID
Teacher: t + UserAccount.personID
Administrator: a + UserAccount.personID
Relative: r + UserAccount.personID
Guardian: g + UserAccount.personID

Not shown in the UI

System Administration > User Security > Users > User Account

Why is a user not being retrieved from Campus?

For OneRoster 1.0 and 1.1, users need user accounts to be included in OneRoster. User accounts can be created individually, en masse, or automatically

Teachers need a District Assignment with a Role of Teacher marked.

Non-Teachers staff members need a District Assignment with a Role other than or in addition to Teacher marked.