Sections Tool API -- WORKING DRAFT

Owned by Former user (Deleted)
Last updated: Jul 26, 2005Version comment
1 min read

Sections Tool API

While the "Section Awareness API" will feed all of Sakai's section aware tools, including the section manager tool, this API does not provide the "writable" methods needed by the section manager. This is a rough draft of the methods needed by the section manager that are not included in the "Section Awareness API".

Section Awareness methods (these are not necessary, but simply possibilities for optimization)

  • getSectionsWithInstructors(String courseId)

Student-accessible methods

  • joinSection(String sectionId)
  • dropSection(String sectionId)

Instructor / TA accessible methods

  • addSectionMembership(String userId, Role role, String sectionId)
  • dropSectionMembership(String userId, String sectionId)
  • findUsers(String searchPattern) // Global or limited to current context? TBD
  • addSection(String courseId, String title, String meetingTimes, String sectionLeaderId, int maxEnrollments, String location) // Assumes that the calendar service won't be used for setting meeting times
  • updateSection(CourseSection section)
  • disbandSection(String sectionId)
  • isSelfRegistrationAllowed(String courseId)
  • setSelfRegistrationAllowed(String courseId, boolean allowed)
  • isSectionSwitchingAllowed(String courseId)
  • setSectionSwitchingAllowed(String courseId, boolean allowed)