ELIS 2014 Manual

ELIS Data Hub 2

Web Services for Data Hub

Web Services can be used with Data Hub versions 2.3.2.2+ and 2.4.2.3+.

The following Moodle documentation links have information about Web Services and security keys (tokens):
The following Github project link has test web services clients pre-built to work with Moodle in a few programming languages, https://github.com/moodlehq/sample-ws-clients.

There is also a checklist of steps to go through on every Moodle / ELIS 2.x site at Administration block > Site Administration > Plugins > Web Services > Overview. Each step links to a page where the step can be completed.

Web services overview page

The web services developer documentation can be enabled by going to the Administration block > Site Administration > Plugins > Web Services > Manage Protocols. Select the Web services documentation checkbox at the bottom of the page to enable the documentation.

Enabling Web services documentation

The documentation lists the available methods and their inputs and outputs. To access the documentation as an admin user go to the Administration block > Site Administration > Plugins > Web Services > API Documentation.

Data Hub web services API documentation

Select the function you want to view documentation for. The documentation opens beneath the selected function.

Data Hub web services API documentation

A user assigned a Web Services role can view the documentation by going to the Administration block > My profile settings > Security keys and selecting the Documentation link on the right side of the RLDH Webservices column.

Web Services docs link for a user assigned a Web Services role

The web services role should have the permission 'Create a web service token - moodle/webservice:createtoken' enabled, it is located at the end of the System section of the permissions/capabilities. And one or more of the web service protocols should be enabled, those permissions are located a few sections below the Course permissions/capabilities.