Note: You are currently viewing documentation for Moodle 3.1. Up-to-date documentation for the latest stable version of Moodle is probably available here: eLeDia Webservicesuite.

eLeDia Webservicesuite

From MoodleDocs
Revision as of 13:21, 20 March 2015 by Benjamin Wolf (talk | contribs) (Created page with "{{Infobox plugin |type = Local |entry = https://moodle.org/plugins/view.php?plugin=local_eledia_webservicesuite |tracker = https://tracker.moodle.org/browse/CONTRIB-5010 |disc...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Overview

This plugin provides new webservice functions for moodle.

Installation

  1. Make sure you have all the required versions.
  2. Download the eLeDia Webservicesuite plugin.
  3. Unzip it into your moodle/local/ directory.
  4. Login to you moodle as Administrator and go to Site administration -> Notifications to trigger the installation process.

For more information see Installing contributed modules or plugins.

Using

The new functions appear within the moodle webservice function list after installation. The functions definition can be found within the API Documentation in Site Administration/Plugins/Web Services.

List of functions:

  • elediaservice_update_users_by_idnumber => updates the submittet user profile identified by idnumber
  • elediaservice_enrol_users_by_idnumber => enrolls users in the given courses, users and courses are identified by idnumber
  • elediaservice_get_courses_by_idnumber => returns a course object according to the given idnumber
  • elediaservice_update_courses_by_idnumber => updates a course object according to the given idnumber
  • elediaservice_get_user_by_idnumber => returns a list of users object according to the given idnumbers
  • elediaservice_unenrol_users_by_idnumber => enrolls a list of users from the given enrollment in the given courses, user and courses identified by idnumber
  • elediaservice_course_completion => returns the completion information for the user with the given idnumber and the course with the given idnumber
  • elediaservice_get_user_by_mail => DEPRECATED: use core_user_get_users_by_field instead
  • elediaservice_get_users_by_idnumber => DEPRECATED: use core_user_get_users_by_field instead

Credits

eLeDia - E-Learning im Dialog GmbH

Mail: info@eledia.de

See Also

Tracker component

Modules & Plugins database entry

Github

You can also find the code on Github.

https://github.com/eledia/local_eledia_webservicesuite/tree/v_28

NOTE: In Github we use an empty master branch. The different plugin versions can be found in special branches for each Moodle version.