Sync Webservice

Local plugins ::: local_sync_service
Maintained by Daniel Schröter
Moodle plugin for extending the Moodle Web Service API for remote course module creation and course file synchronisation.

Sync Webservice 2024061800

Moodle 3.11, 4.0, 4.1, 4.2
Released: Dienstag, 18. Juni 2024, 22:22
Install nowDownload

Code prechecks

overview phplint phpcs8 | 45 js css phpdoc6 | 0 savepoint thirdparty grunt shifter mustache gherkin
HTML | XML

Moodle Plugin "sync_service"

Since version 3.0.5: The setting "restrictedusers" is now disabled and the webservice will now be available for all users.

This plugin for Moodle (type: local) adds serveral functions to the Moodle Web Service API. Those fuctions allow users and external services to remotely create and move new course modules. Furthermore an external service (called "Course Sync Extension Service") containing the newly added functions and other core web service functions, which are helpful to use the added functions, is added.

The plugin is developed to work with the desktop application MoodleSync, used for file synchronization between a local directory and the learning platform Moodle.

Following functions are added:

Function Description Note
local_course_add_new_course_module_url Add course module URL
local_course_add_new_course_module_resource Add course module Resource File needs to be uploaded with "/webservice/upload.php" web service call.
local_course_add_new_course_module_directory Add course modul Folder Files need to be uploaded with "/webservice/upload.php" web service call.
local_course_add_files_to_directory Add files to existing folders Files need to be uploaded with "/webservice/upload.php" web service call; since version 3.0.0
local_course_move_module_to_specific_position Move a module to a dedicated position
local_course_add_new_section Create and position a new course section Since version 2.0.0

Usage:
* Tested on Moodle versions 3.11.4, 4.0.2, 4.1.2. and 4.2.2. * Usage of the "REST (returning JSON)"- web service protocol. * To install the plugin, you may use the in-build plugin installation interface. Or you can unzip the archive and copy the folder "sync_service" into the directory "\server\moodle\local". Afterwards restart Moodle, log-in as an admin and follow the installation process. * To use the added fuctions, either enable and use the added external service (file upload and file download must be allowed) or create a new external service.

Version information

Version build number
2024061800
Maturity
Unknown
MD5 Sum
4f1fb68b2c7d4d0f61a58789e897f03c
Supported software
Moodle 3.11, Moodle 4.0, Moodle 4.1, Moodle 4.2
  • Latest release for Moodle 3.11
  • Latest release for Moodle 4.0
  • Latest release for Moodle 4.1
  • Latest release for Moodle 4.2

Version control information

Version control system (VCS)
GIT
VCS repository URL
VCS tag
v3.0.5

Default installation instructions for plugins of the type Local plugins

  1. Make sure you have all the required versions.
  2. Download and unpack the module.
  3. Place the folder in the "local" subdirectory.
  4. Visit http://yoursite.com/admin to finish the installation.