Skip to content

Latest commit

 

History

History
53 lines (33 loc) · 2.13 KB

README.md

File metadata and controls

53 lines (33 loc) · 2.13 KB

local_webservices

A moodle plugin for local web service functions.

Use this plugin to implement custom external functions, which are not related to a specific plugin.

Instructions for get_completion_for_courseid

This web service function returns a set of completiondata (username, completiondate and completionstatus) for a given courseid.

The administrator has to create a web service token for a user under Site Administration > Plugins > Web services > Manage tokens.

Then the user will be able to call the external function get_completion_for_courseid via the token and the courseid, given that the user is a teacher in the chosen course. See https://docs.moodle.org/dev/Creating_a_web_service_client for more information on how to call a web service function

Installing via uploaded ZIP file

  1. Log in to your Moodle site as an admin and go to Site administration > Plugins > Install plugins.
  2. Upload the ZIP file with the plugin code. You should only be prompted to add extra details if your plugin type is not automatically detected.
  3. Check the plugin validation report and finish the installation.

Installing manually

The plugin can be also installed by putting the contents of this directory to

{your/moodle/dirroot}/local/webservices

Afterwards, log in to your Moodle site as an admin and go to Site administration > Notifications to complete the installation.

Alternatively, you can run

$ php admin/cli/upgrade.php

to complete the installation from the command line.

License

2024 Irina Hoppe

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.