Reading Hierarchies
When you know the SyncId of a Hierarchy, you can always retrieve it again from Itslearning. Beside that, it is also possible to retrieve all Hierarchies belonging to a specific User.
ReadHierarchy
This function retrieves the specified Hierarchy from Itslearning.
Syntax:
OperationResult warning = ImsEsClient.ReadHierarchy(string syncId, out Hierarchy readHierarchy);
Parameters:
syncId:
The Id of the Hierarchy to be retrieved.
readHierarchy:
The retrieved Hierarchy.
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.
ReadHierarchies
This function retrieves the specified Hierarchies from Itslearning.
Syntax:
BatchOperationResult warnings = ImsEsClient.ReadHierarchies(ICollection<string> syncIds, out List<Hierarchy> readHierarchyList);
Parameters:
syncIds:
An ICollectionwith the Ids of the Hierarchies to be retrieved.
readHierarchyList:
A list with the retrieved Hierarchies.
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.
ReadHierarchiesFromUser
This function retrieves all the Hierarchies from Itslearning that are attached to the given User.
Syntax:
OperationResult warning = ImsEsClient.ReadHierarchiesFromUser(string syncKey, out List<Hierarchy> readHierarchyList);
Parameters:
syncKey:
The SyncKey of the User.
readHierarchyList:
A list with the retrieved Hierarchies.
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.