Reading Courses
With the following functions it is possible to retrieve information about Courses in Itslearning, but only the Courses that have been created through IMS-ES, and where the linked Hierarchies not have been deleted.
ReadCourse
This function retrieves the specified Course from Itslearning.
Syntax:
OperationResult warning = ImsEsClient.ReadCourse(string syncId, out Course readCourse);
Parameters:
syncId:
The Id of the Course.
readCourse:
The retrieved Course.
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.
ReadCourses
This function retrieves the specified Courses from Itslearning.
Syntax:
BatchOperationResult warnings = ImsEsClient.ReadCourses(ICollection<string> syncIds, out List<Course> readCourseList);
Parameters:
syncIds:
An ICollection with the Ids of the Courses.
readCourseList:
A list with the retrieved Course.
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.
ReadCoursesFromUser
This function retrieves all the Courses from Itslearning that are attached to the given User.
Syntax:
OperationResult warning = ImsEsClient.ReadCoursesFromUser(string syncKey, out List<Course> readCourseList);
Parameters:
syncKey:
The SyncKey of the User.
readCourseList:
A list with the retrieved Courses.
Returns:
The OperationResult containing 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.