OneRoster API Error Messages
Hello! I've developed an app that uses OneRoster to post assignments and grades from an LMS to Blackbaud using the OneRoster API.
When there is any issue with the assignment or grade to be posted, the API provides a generic error message: {"statusInfoSet":[{"imsx_codeMajor":"failure","imsx_severity":"error"}]}
From my experience thus far, this could mean:
Data incompatibility:
- lineItem assignDate is not between gradingPeriod.beginDate and gradingPeriod.endDate
- gradingPeriod provided is not child of lineItem.class
- result.student is not enrolled in lineItem.class
- result.scoreDate (or date of request) is before lineItem.assignDate
- result.score is less than result.resultValueMin or greater than result.resultValueMax
Functional incompatibility:
- Result has already been posted for the student and lineItem within the UI. As this isn't an “external” line item, there is no way to confirm this with the API
The OneRoster specification for error payloads provides for an optional human-readable description of the error that occurred - could this be provided based on the reason for the failure? This lack of information has caused many hours of headache trying to identify the issue, and also confusion with teachers and admins who do not know why their data failed to sync.
Comments
-
@Michael Conan
I recommend you also post your enhancement suggestion to the “ideas” section of the user community atThere, other users can vote and add additional comments. Product managers review and update the ideas from this “idea bank” when they plan product roadmaps and more. You can post a link to the idea here in this discussion thread to drive more traffic to your idea.
1 -
1
Categories
- All Categories
- 6 Blackbaud Community Help
- 211 bbcon®
- 1.4K Blackbaud Altru®
- 396 Blackbaud Award Management™ and Blackbaud Stewardship Management™
- 1.1K Blackbaud CRM™ and Blackbaud Internet Solutions™
- 15 donorCentrics®
- 360 Blackbaud eTapestry®
- 2.5K Blackbaud Financial Edge NXT®
- 650 Blackbaud Grantmaking™
- 568 Blackbaud Education Management Solutions for Higher Education
- 3.2K Blackbaud Education Management Solutions for K-12 Schools
- 937 Blackbaud Luminate Online® and Blackbaud TeamRaiser®
- 84 JustGiving® from Blackbaud®
- 6.5K Blackbaud Raiser's Edge NXT®
- 3.7K SKY Developer
- 248 ResearchPoint™
- 119 Blackbaud Tuition Management™
- 165 Organizational Best Practices
- 239 The Tap (Just for Fun)
- 34 Blackbaud Community Challenges
- 31 PowerUp Challenges
- 3 (Open) PowerUp Challenge: Data Health
- 3 (Closed) Raiser's Edge NXT PowerUp Challenge: Product Update Briefing
- 3 (Closed) Raiser's Edge NXT PowerUp Challenge: Standard Reports+
- 3 (Closed) Raiser's Edge NXT PowerUp Challenge: Email Marketing
- 3 (Closed) Raiser's Edge NXT PowerUp Challenge: Gift Management
- 4 (Closed) Raiser's Edge NXT PowerUp Challenge: Event Management
- 3 (Closed) Raiser's Edge NXT PowerUp Challenge: Home Page
- 4 (Closed) Raiser's Edge NXT PowerUp Challenge: Standard Reports
- 4 (Closed) Raiser's Edge NXT PowerUp Challenge: Query
- 785 Community News
- 2.9K Jobs Board
- 53 Blackbaud SKY® Reporting Announcements
- 47 Blackbaud CRM Higher Ed Product Advisory Group (HE PAG)
- 19 Blackbaud CRM Product Advisory Group (BBCRM PAG)

