{"id":27,"date":"2016-03-01T13:14:52","date_gmt":"2016-03-01T11:14:52","guid":{"rendered":"http:\/\/www.spanidis.eu\/?p=27"},"modified":"2019-12-05T14:26:32","modified_gmt":"2019-12-05T12:26:32","slug":"moodle-rest-web-services-tutorial-example-instructions-guidelines","status":"publish","type":"post","link":"http:\/\/www.spanidis.eu\/?p=27","title":{"rendered":"Moodle REST Web Services tutorial \u2013 example \u2013 instructions \u2013 guidelines"},"content":{"rendered":"

You may download my php example<\/a> here.<\/p>\n

Here you will find instructions<\/strong> to create Web Services<\/strong> on Moodle<\/strong>.
\nI am not a Moodle expert. I have collected these information from many different sources and I have eliminated their errors to give you an easy to follow tutorial together with a working example.
\nThis tutorial creates a web service, enabled to create a new user and to enroll this user to a course.<\/p>\n

Please follow the steps below:<\/p>\n

1) Create the user which will serve the web services.
\nGo to:
\nSite Administrator > Users > Accounts > Add new user
\nUsername: wsuser (user your own)
\nPassword: (user your own)
\nFill in the required fields.<\/p>\n

2) Give the wsuser the appropriate role.
\nGo to:
\nSite Administrator > Users > Permissions > Define roles
\nPress the Add new role button.
\nSelect Role archetype = ARCHETYPE<\/strong>: Manager and press continue.
\nOn the form:
\nWeb Service User
\nContext types where this role may be assigned: System\/User\/Category\/Course
\nLeave the rest selections as they appear.
\nCapabilities
\nAdd the following capabilities:
\nwebservice\/rest:use
\nmoodle\/user:create
\nenrol\/manual:enrol
\nenrol\/category:synchronised
\nenrol\/manual:unenrolself
\nPress Create this role button.<\/p>\n

3) Assign System roles.
\nGo to:
\nSite Administrator > Users > Permissions > Assign System Roles
\nAssign wsuser user.<\/p>\n

4) Create the needed services.
\nGo to:
\nSite Administrator > Plugins > Web Services > External Services
\nWe need the two services below:<\/p>\n

a) Create user \u2013 service<\/strong>
\nOn custom services table press add.
\nName: create_user
\nShort: create_user
\n“Enabled” should be checked.
\n“Authorized users only” should be checked.
\nPress “show more”.
\nSearch for capability moodle\/user:create and select it.
\nPress “add service”.
\nThis service has no functions.
\nAdd functions.
\nSearch for the core_user_create_user<\/strong>
\nSelect it and press add function.<\/p>\n

b) Enroll user \u2013 service<\/strong>
\nOn custom services table press “add”.
\nName: enrol_user
\nShort: enrol_user
\n“Enabled” should be checked.
\n“Authorized users only” should be checked.
\nPress “show more”.
\nSearch for capability enroll\/manual:enrol and select it.
\nPress “add service”.
\nThis service has no functions.
\nAdd functions.
\nSearch for the enrol_manual_enrol_users<\/strong>
\nSelect it and press “add function”.
\nOn the list of custom services you have to add the authorized user to be the wsuser.<\/p>\n

5) Create the Tokens.
\nGo to:
\nSite Administrator > Plugins > Web Services > External Services > Manage Tokens
\nAdd
\na) Create User
\nSelect user Web Service User
\nService \u2013 create user
\nSave changes.<\/p>\n

b) Enroll User
\nSelect user Web Service User
\nService \u2013 enrol user
\nSave changes.<\/p>\n

You now have the two required tokens.<\/p>\n

6) All web service protocols are disabled. The \u00abEnable web services\u00bb setting can be found in Advanced features.
\nGo to:
\n\u2022 Site Administrator > Advanced features > Enable web services checked \u2013 Save.
\n\u2022 Site Administrator > Plugins > Web Services > External Services > Manage Protocols.
\nActivate REST<\/strong> protocol.
\nCheck the documentation box.<\/p>\n

7) CURL.php is required on the client side. You may download it here<\/a>.
\n8) Check if create user works using php code.
\n9) Check if enroll user works using php code.
\n10) The wsuser user can not assign role without being enrolled in the course\/s!!!<\/p>\n

Best regards
\nPavlos<\/p>\n","protected":false},"excerpt":{"rendered":"

You may download my php example here. Here you will find instructions to create Web Services on Moodle. I am not a Moodle expert. I have collected these information from many different sources and I have eliminated their errors to give you an easy to follow tutorial together with a working example. This tutorial creates … Continue reading Moodle REST Web Services tutorial \u2013 example \u2013 instructions \u2013 guidelines<\/span> →<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[1],"tags":[10,6,8,9],"_links":{"self":[{"href":"http:\/\/www.spanidis.eu\/index.php?rest_route=\/wp\/v2\/posts\/27"}],"collection":[{"href":"http:\/\/www.spanidis.eu\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/www.spanidis.eu\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/www.spanidis.eu\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"http:\/\/www.spanidis.eu\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=27"}],"version-history":[{"count":8,"href":"http:\/\/www.spanidis.eu\/index.php?rest_route=\/wp\/v2\/posts\/27\/revisions"}],"predecessor-version":[{"id":54,"href":"http:\/\/www.spanidis.eu\/index.php?rest_route=\/wp\/v2\/posts\/27\/revisions\/54"}],"wp:attachment":[{"href":"http:\/\/www.spanidis.eu\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=27"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/www.spanidis.eu\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=27"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/www.spanidis.eu\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=27"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}