OneRoster 1.2
Errors and limits
Error codes, rate limits and what is not supported yet.
Errors
Errors use OneRoster's status info shape (imsx_codeMajor, imsx_severity, imsx_description, imsx_CodeMinor).
| HTTP | imsx_codeMinorFieldValue | When |
|---|---|---|
| 400 | invalid_filter_field, invalid_sort_field, invalid_selection_field, invalid_data | Invalid parameter |
| 401 | unauthorisedrequest | Missing, wrong or expired token; revoked connection; another school's token |
| 403 | forbidden | The token's scopes do not cover the endpoint |
| 404 | unknownobject | No such endpoint or record |
| 429 | server_busy | Over 600 requests a minute; wait and retry |
| 500 | internal_server_error | Server error; retry later and report it if it persists |
| 503 | (none) | Briefly unavailable; retry in a few minutes |
Limits
- 600 requests per minute per connection.
- Token requests: 60 per 15 minutes per network address.
- At most 10 active connections per school.
Not supported yet
- Writes over OneRoster REST: the standard has no roster writes, and results are produced by the portal itself. To send data to the portal, use a OneRoster CSV package or the portal API.
- The Resources service and guardians. Teachers, grading periods and demographics have endpoints that are always empty.
- Webhooks.