Reading CourseGroups

When you know the SyncId of a CourseGroup, you can always retrieve it again from Itslearning. Beside that, it is also possible to retrieve all CourseGroups belonging to a specific User.

ReadCourseGroup

This function retrieves the specified CourseGroup from Itslearning.

Syntax:

OperationResult warning = ImsEsClient.ReadCourseGroup(string syncId, out CourseGroup readCourseGroup);

Parameters:

syncId:

The Id of the CourseGroup to be retrieved.

readHierarchy:

The retrieved CourseGroup.

Returns:

The OperationResult containing the warning that Itslearning has send back, or if there was none, null.

Exceptions:

  • ImsEsException: If IMS-ES encountered an error in Itslearning, this exception will be thrown.

ReadCourseGroups

This function retrieves the specified CourseGroups from Itslearning.

Syntax:

BatchOperationResult warnings = ImsEsClient.ReadCourseGroups(ICollection<string> syncIds, out List<CourseGroup> readCourseGroupList);

Parameters:

syncIds:

An ICollection with the Ids of the CourseGroups to be retrieved.

readHierarchyList:

A list with the retrieved CourseGroups.

Returns:

A BatchOperationResult with the list of warnings that Itslearning has send back (this list can be empty).

Exceptions:

  • ImsEsBatchException: If IMS-ES encountered an error in Itslearning, this exception will be thrown.

ReadCourseGroupsFromUser

This function retrieves all the CourseGroups from Itslearning that are attached to the given User.

Syntax:

OperationResult warning = ImsEsClient.ReadCourseGroupsFromUser(string syncKey, out List<CourseGroup> readCourseGroupList);

Parameters:

syncKey:

The SyncKey of the User.

readHierarchyList:

A list with the retrieved CourseGroups.

Returns:

The OperationResult containing the warning that Itslearning has send back, or if there was none, null.

Exceptions:

  • ImsEsException: If IMS-ES encountered an error in Itslearning, this exception will be thrown.