Blackboard API Endpoints Used by the Hypothesis LMS App

Jump to bottom

Marcos Prieto edited this page Nov 24, 2022 · 2 revisions

The Hypothesis LMS app includes an optional feature set for Blackboard which allows users to:

Select PDFs from their Blackboard course file repository
Launch a reading using an specific Blackboard group set

API endpoints

Blackboard admins should know that the Hypothesis LMS app accesses the following Blackboard API endpoints:

/learn/api/public/v1/courses/uuid:{course_id}/resources
/learn/api/public/v1/courses/uuid:{course_id}/resources/{folder_id}/children

List of files in the course and course folders for the file browser while configuring assignments.

/learn/api/public/v1/courses/uuid:{course_id}/resources/{file_id}?fields=downloadUrl

Public URL of a file for launching a previously configured blackboard file assignment.

/learn/api/public/v2/courses/uuid:{course_id}/groups/sets

Group sets in a course. For configuring a new group assignment.

/learn/api/public/v2/courses/uuid:{course_id}/groups/sets/{group_set_id}/groups

Groups in a course and group set. For getting the list of groups while launching the assignment as an instructor.

/learn/api/public/v2/courses/uuid:{course_id}/groups
/learn/api/public/v2/courses/uuid:{course_id}/groups/{group['id']}

To check student group memberships when learners launch group assignments.