CourseGroups

CourseGroups are the groups of users inside a Course.They can be both created through the Itslearning UI and IMS-ES, but if you created them through the UI, you will not be able to change/delete them through IMS-ES. In practise the CourseGroups are very similar to normal Hierarchies, except that they always have to be added to a Course (the parent must be of type Course).

CourseGroups have the following properties:

Property	Description	Requirements
SyncId	Unique identifier for this CourseGroup. (also known as Synchronization Identifier)	Required, max length is 255.
Title	The Title of the CourseGroup, this is what will be shown in Itslearning.	Required, max length is 64.
Description	A description of the CourseGroup, this property is not really used in Itslearning.
ParentHierarchyId	The SyncId of the parent Course, the Course one level above.	Required.
GroupType	Will always be CourseGroup.
VisibleInSearch	True/False if the CourseGroup will be visible in searches, for example when selecting users to send an email to.

Creating a CourseGroup:

As with creating a hierarchy, when you are creating a new CourseGroup the SyncId must always be given. The other properties can be set later on, or when defining the object:

var newCourseGroup = new CourseGroup(“syncId”)
    {
        Title = “Title”,
        Description = “Description”,
        etc.
     };

Functions:

In the IMS-ES Template the following functions are connected to a Hierarchy:

CreateCourseGroup
CreateCourseGroups

ReadCourseGroup
ReadCourseGroups
ReadCourseGroupsFromUser

UpdateCourseGroup
UpdateCourseGroups
ReplaceCourseGroup
ReplaceCourseGroups
ChangeCourseGroupId
ChangeCourseGroupIds

DeleteCourseGroup
DeleteCourseGroups