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:
| Object | Campus Equivalent | Campus Database | Campus Path |
|---|---|---|---|
| Academic Sessions | Term Schedule | Term.termID | Not shown in the UI System Administration > Calendar > Calendar > Terms |
| Class | Section | Section.sectionID | Scheduling > Course > Section > SectionID |
| Course | Course | Course.courseID | Scheduling > Courses > Course > CourseID |
| Demographics | Identity | Identity.identityGUID | Census > 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 Period | Not captured in Campus - placeholder created based on Term | N/A | N/A |
| Line Item | Grading Task/Standard and Section Term Mask | Section.sectionID + (no spaces) | Not shown in the UI Scheduling > Courses > Grading Tasks, Standards |
| Line Item Category | Not captured in Campus - always returns 00000000-0000-0000- 0000-000000000000 | N/A | N/A |
| Org | District or School | District.districtGUID School.schoolGUID | Not shown in the UI System Administration > Resources > District Information |
| Result | Posted Grades | GradingScore. externalLMSSourcedID | Not shown in the UI - generated by the system of record (Campus or Vendor) |
| Score Group | Score Group or Rubric | ScoreGroup.scoreGroupID | Not shown in the UI |
| Term | Term | Children of Academic Sessions Term.termID | Children of Academic Sessions System Administration > Calendar > Calendar > Terms |
| User | Person + role in Campus (student, staff, teacher) | Student: s + 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.
