Show Advanced KnowledgeHide Advanced Knowledge

SOAP: include online/offline status of learning modules in object xml

1 Initial Problem

Object data retrieved via SOAP methods like getObjectByReference does not include online/offline status of the given object.

The offline status info is required for the following object types:

• Learning Modules
• HTML Learning Modules
• Courses
• Surveys
• Tests
• SCORM Learning Modules

2 Conceptual Summary

There is no centralized possiblity to retrieve the offline status of different object types. To avoid dependencies on other modules, a revision of the offline status handling should be implemented:

Centralizing online/offline status - step 1

3 User Interface Modifications

This feature does not include any user interface modifications.

4 Technical Information

The offline status can be read using the following SOAP methods:

• getObjectByReference
• getObjectsByTitle
• searchObjects
• getTreeChilds
• getXMLTree

Modifying the offline status will be possible using the following existing SOAP methods:

• addObject
• updateObject

5 Contact

• Author of the Request:
• Maintainer: Meyer, Stefan [smeyer]
• Implementation of the feature is done by: {The maintainer must add the name of the implementing developer.}

6 Funding

If you are interest in funding this feature, please add your name and institution to this list.

• ...

7 Discussion

Kunkel, Matthias [mkunkel], 05 JUN 2018 : The title focuses on learning modules only. But chapter 2 says "object like learning modules" which mean that this is related to other object types that support online/offline, too. So does this change tackles all objects with online/offline status or only ILIAS learning modules?

Kunkel, Matthias [mkunkel], 02 JUL 2018 : Highly appreciated and scheduled for 5.4.

8 Implementation

{The maintainer has to give a description of the final implementation and add screenshots if possible.}

Test Cases

JourFixe-2018-09-10 has drecreed

We do not want manual testing of the SOAP interface but prefer an automatic procedure. Facing the upcoming Service Discovery, we postpone testing of SOAP for 5.4 and hope we can solve this problem with the Service Disco. Test cases in Testrail can be removed.

Approval

Meyer, Stefan [smeyer]: 26 Oct 2018 by Arne Schröder