Integrations
Enhanced course grades public REST API – Exceptions (Student Attempts) – 3900.104
Blackboard Learn SaaS, Blackboard Learn 9.1
Ultra Experience
Ultra Course View
Impact: Administrators
Related Topic: Blackboard Learn APIs
We enhanced Blackboard’s public REST API for course grades to improve grading exception management for individual student assessments. Grading exceptions include:
- extending due dates,
- allowing additional attempts, and
- providing more flexible grading options.
Developers can now retrieve parameters for grading exceptions to an individual student's assessment. Developers can also set exception parameters for a user-specific start date, hide date, and other parameters. The attributes are in all the endpoints. The endpoints are:
GET -
- /learn/api/public/v1/courses/{{courseId}}/gradebook/columns/{columnId}/exceptions/users/{{userId}}
POST - This method is traditionally intended for creating resources. However, there are specific circumstances with the GET due to some technical constraints and the POST for this occasion will be used to retrieve information about the exceptions, the retrieve will be made to a gradebook column (Retrieve all students associated to that column). This is because it allows the request to include detailed parameters in the body, taking advantage of the ability to send more extensive data and without the constraints associated with GET requests url length.
- /learn/api/public/v1/courses/{{courseId}}/gradebook/columns/{columnId}/exceptions
PUT - This allows users to create or modify an exception for a student.
- /learn/api/public/v1/courses/{{courseId}}/gradebook/columns/{columnId}/exceptions/users/{{userId}}
DELETE - Deletes the exception for a student.
- /learn/api/public/v1/courses/{{courseId}}/gradebook/columns/{columnId}/exceptions/users/{{userId}}
If the option is enabled, end users can read and update the assessment's due date, additional attempts, and rescheduled due date.
The required privileges and entitlements for student exception endpoints for course grades API are:
For GET and POST:
- entitlement: course.gradebook-item.exceptions.VIEW
- privilege: Course/Organization Gradebook > Gradebook Item > Exceptions > View Item Due Date Exception
For PUT and DELETE:
- entitlement: course.gradebook-item.exceptions.MODIFY
- privilege: Course/Organization Gradebook > Gradebook Item > Exceptions > Edit Item Due Date Exception
For administrators: This feature is available for all Ultra courses. There are no configurations needed.