Collaborate API Objects

Document created by scott.hurrey on Mar 9, 2018
Version 1Show Document
  • View in full screen mode

The Blackboard Collaborate API is built to allow a third-party application to perform scheduler operations. To handle this, the API exposes several objects that may or may not be familiar to you. In order to set the stage, here is a glossary of the API Objects in play.


SessionSessions are the life-blood of Collaborate's API. A session is equivalent to a meeting room. If you login to the scheduler and create a room, you are creating a session.
InstanceAn instance is an individual meeting in a session. An instance is created when the first person logs into the Collaborate session, and is terminated when the last person leaves the session.
EnrollmentAn enrollment is a User that has been invited to a session. Enrolling a user allows you to provide an individual URL to an individual user, such that when they enter the room, Collaborate knows who the user is.
UserAs you would expect, this object corresponds to a session attendee
ContextContext is a container for grouping sessions. Typically in an LMS integration, the Context would correspond to a course or section, and all the sessions in that course would belong to that context. Context is not required, and it can be used for any logical grouping. It doesn't have to be a course.
RecordingA stored recording of a session instance.
2 people found this helpful