Blackboard

Retrieves a list of gradebook columns for a specified course in the Blackboard Learn environment. This endpoint allows users to access detailed information about the structure and components of a course's gradebook. It should be used when there's a need to view or analyze the grading schema for a particular course, su…

Untrusted display-only summary

Retrieves detailed information about a specific grade notation within a course's gradebook in the Blackboard Learning Management System. This endpoint allows users to fetch individual grade notation data, which may include the notation symbol, description, and associated grading rules. It should be used when precise i…

Untrusted display-only summary

Retrieves the grade notations for a specific course's gradebook in the Blackboard learning management system. Grade notations are symbols or short texts used to represent specific grading statuses or conditions (e.g., 'A', 'B+', 'Incomplete', 'Withdrawn'). This endpoint should be used when you need to fetch the comple…

Untrusted display-only summary

Retrieves the gradebook schemas for a specific course in the Blackboard learning management system. This endpoint allows developers to access the structure and format of the gradebook data for a given course, which is crucial for understanding how grades are organized and stored within Blackboard. It can be used when…

Untrusted display-only summary

Retrieves detailed information about a specific gradebook period within a course in the Blackboard learning management system. This endpoint allows users to access important data related to a particular grading period, such as its start and end dates, associated assignments, and any specific grading policies. It's par…

Untrusted display-only summary

Retrieves the gradebook periods for a specified course in the Blackboard learning management system. This endpoint allows users to fetch information about the temporal structure of grade entries and assessments within a particular course. It is useful for understanding how the course's grading is organized over time,…

Untrusted display-only summary

Retrieves detailed information about a specific group within a particular course in the Blackboard learning management system. This endpoint is used to access group data, which may include the group's name, description, membership, and other relevant details. It's particularly useful for instructors or administrators…

Untrusted display-only summary

Retrieves detailed information about a specific user's membership or role within a group in a particular course on the Blackboard platform. This endpoint is used to access user-specific data in the context of their group participation within a course. It provides information such as the user's role in the group, join…

Untrusted display-only summary

Retrieves a list of users belonging to a specific group within a Blackboard Learn course. This endpoint is used to access user information for group-based activities, collaborative assignments, or administrative purposes. It provides details about the members of a particular group, which can be useful for instructors…

Untrusted display-only summary

Retrieves a list of all groups associated with a specific course in the Blackboard learning management system. This endpoint is useful for obtaining information about the various student groups, project teams, or study circles within a particular course. It should be used when you need to access group data for course…

Untrusted display-only summary

Retrieves detailed information about a specific group set within a course in the Blackboard learning management system. This endpoint allows users to fetch the properties and configuration of a particular group set, which may include details such as the group set name, description, availability, and associated groups.…

Untrusted display-only summary

Retrieves a list of groups within a specific group set for a given course in the Blackboard learning management system. This endpoint allows educators and administrators to access detailed information about the groups created within a particular group set, facilitating management of student collaborations and assignme…

Untrusted display-only summary

Retrieves all group sets associated with a specific course in the Blackboard learning management system. Group sets are collections of groups within a course that can be used for various collaborative activities, such as group projects, discussions, or assignments. This endpoint should be used when you need to obtain…

Untrusted display-only summary

Retrieves system information about the Blackboard Learn platform. This endpoint provides essential metadata about the current state of the Blackboard system, which can include details such as the platform version, configuration settings, and operational status. It is particularly useful for administrators, developers,…

Untrusted display-only summary

Retrieves detailed information about a specific institutional role in the Blackboard learning management system. This endpoint should be used when you need to access the properties, permissions, or settings associated with a particular role within an educational institution. It provides valuable data for role manageme…

Untrusted display-only summary

Retrieves a list of all institution roles defined within the Blackboard Learn environment. This endpoint is crucial for administrators and developers who need to understand and manage the various roles available in their institution's Blackboard system. It provides a comprehensive overview of the role structure, which…

Untrusted display-only summary

Retrieves active login sessions for users in the Blackboard learning management system. This endpoint is used to monitor and manage current user sessions across the platform. It provides a list of all ongoing login sessions, which can be crucial for system administrators to track user activity, troubleshoot access iss…

Untrusted display-only summary

Retrieves detailed information about a specific user within a particular course in the Blackboard learning management system. This endpoint is used to fetch user-specific data in the context of a given course, which may include enrollment status, role in the course, progress, or other relevant details. It should be us…

Untrusted display-only summary

Retrieves a list of courses associated with a specific category in the Blackboard catalog. This endpoint allows users to fetch course information based on the category type and category ID, providing a way to browse or search for courses within a particular organizational structure. It's useful for applications that n…

Untrusted display-only summary

Retrieves a list of participants for a specific message within a Blackboard course. This endpoint allows users to access information about who is involved in a particular course message, which can be useful for tracking student engagement, managing communication, or analyzing participation patterns. It should be used…

Untrusted display-only summary

Retrieves all replies to a specific message within a discussion thread of a course in the Blackboard learning management system. This endpoint allows users to access the responses and interactions related to a particular message in a course discussion. It is useful for viewing the conversation thread, monitoring stude…

Untrusted display-only summary

Retrieves all messages associated with a specific course in the Blackboard learning management system. This endpoint is used to access course-related communication, announcements, and notifications. It provides a comprehensive view of all messages within the context of a particular course, which can include instructor…

Untrusted display-only summary

Retrieves detailed information about a specific node within the institutional hierarchy of Blackboard. This endpoint allows users to fetch data about a particular component or entity in the educational institution's structure. It should be used when specific information about a node, such as its attributes, relationsh…

Untrusted display-only summary

Retrieves the administrative status of a specific user for a particular node within the Blackboard institutional hierarchy. This endpoint allows you to check whether a user has administrative privileges for a given organizational unit, such as a department or course. Use this endpoint when you need to verify a user's…

Untrusted display-only summary

Retrieves the list of administrators associated with a specific node in the Blackboard institutional hierarchy. This endpoint is used to fetch administrative information for a particular organizational unit, such as a department, school, or program within an educational institution. It provides insights into the manag…

Untrusted display-only summary

Retrieves the immediate child nodes of a specified parent node in the Blackboard Learn Institutional Hierarchy. This endpoint is used to navigate and explore the hierarchical structure of an educational institution, allowing administrators and authorized users to view the subordinate entities (such as departments, pro…

Untrusted display-only summary

Retrieves a list of courses associated with a specific node in the institutional hierarchy of Blackboard. This endpoint is used to fetch all courses linked to a particular organizational unit (such as a department, faculty, or program) within the educational institution's structure. It provides a way to navigate and e…

Untrusted display-only summary

Retrieves information about the nodes within the institutional hierarchy of a Blackboard learning environment. This endpoint allows users to fetch data representing the organizational structure of an educational institution, such as departments, schools, or other administrative units. It's particularly useful for unde…

Untrusted display-only summary

Retrieves a list of nodes (modules or units) for a specific course in the Blackboard learning management system. This endpoint allows developers to access the structure and content organization of a course, enabling them to build applications that can navigate or display course content. It should be used when there's…

Untrusted display-only summary

Retrieves a list of nodes associated with a specific user in the Blackboard Learn platform. Nodes typically represent courses, organizations, or content areas that the user has access to. This endpoint is useful for obtaining an overview of a user's course enrollments or accessible content areas. It should be used whe…

Untrusted display-only summary