This page describes the implementation of integrating iPeer to Blackboard Learn using building block.

== Requirements ==
* Creating iPeer course from Blackboard
* Syncing instructor accounts from Blackboard to iPeer
* Syncing class roster from Blackboard to iPeer 
* Syncing groups between Blackboard and iPeer
* Sending grades from iPeer to Blackboard grade book
* Single-sign on from Blackboard to iPeer
* (*)Importing iPeer evaluation into Blackboard

(*) Not included in the current project scope. Maybe in the future release.

== Design Overview ==
In order to develop a sustainable environment, the iPeer Blackboard building block communicates with iPeer application through a generalized APIs and web services. Those APIs and web services provides a way for external applications (e.g. LMS or student enrolment system, etc.) to exchange information with iPeer. By calling those APIs and web services, user will be able to control iPeer within Blackboard Learn through iPeer Blackboard building block.
 
{{{
#!html
<img src="https://docs.google.com/drawings/pub?id=1udLvplh9dgTpIW7ImbTQmdDfTTj4f7L3fFMyW-YPpT8&amp;w=781&amp;h=483">
}}}

== Building Block APIs ==

This section is to explore related APIs to implement the iPeer building block. The Blackboard Building Block APIs provides an interface to developer to access the functions and data with Blackboard Learn. Here is a definition from Blackboard building block documentation:

 "A Building Block is an application created by third party developers that is used to extend the functionality of the core Blackboard Learn."

=== Related Building Block APIs ===

==== Course ====
* blackboard.data.course.Course:  a representation of a course (course or organization) within the Blackboard application.
 * Course ID
 * Course title
 * Course description
 * Course start/end date

* blackboard.data.course.Course.Enrollment: the enrollment information from a course.

==== Class Roster ====
* blackboard.data.course.Course.Enrollment: the enrollment information from a course.

* blackboard.data.course.!CourseMembership: public business oriented branding !Course/Students for Membership based data.

* blackboard.data.course.!CourseMembership:  a representation of a course membership record within the Blackboard application. A course membership record defines a user's role within a particular course.

==== Group ====

* blackboard.data.course.Group: a representation of a course group within the Course Management System.
 * Group title
 * Description of the group
 * Group memberships
 * Group size
 * Group creation

* blackboard.data.course.Group.!GroupMember: access to the group member information. Including:
 * First Name
 * Last Name
 * User Name
 * User ID

* blackboard.data.course.!GroupMembership: a representation of a group membership record within the Blackboard application. A group membership record defines a user's inclusion in a particular group.

==== !GradeBook ====
* blackboard.data.gradebook: a package that contains access to Blackboard gradebook.
* blackboard.data.gradebook.Lineitem:  represents a single gradable item in a course.
* blackboard.data.gradebook.Score:  represents a grade in a course for a specific user and Lineitem.

==== !Authentication/Single-Sign On ====

TBD