Lesterhuis Training & Consultancy

085 130 52 99
Inloggen

Cursus rapportage | Webservice functies local course report

Aangepast op: za, 17 aug 2024 3:55 PM

Voordat je begint

In deze instructies gaan we ervan uit dat je weet hoe je:

  • Webservice beschikbaar stelt in Moodle.
    • inschakelen van webservice
    • protocol bepalen
    • externe service aanmaakt
    • functies toewijst aan externe service
    • Token aanmaakt
  • een webservice rol moet maken.
  • hoe je een gebruiker aan webservice rol toewijst.
  • dat je zelf weet (en/of ondersteuning hebt bij) het schrijven van de noodzakelijk code om de webservice functie aan te roepen.
  • dat je een rol hebt met het recht local/coursereport:viewreportdashboardpreset
  • Dat je gebruikers handmatig en/of via moodle standaard webservice functie hebt toegewezen aan deze rol. 



Uitleg over de verschillende webservice functies

De local Coursereport komt met 3 webservice functies:


Functie wat doet het Get informatie
local_coursereport_get_presets Haalt informatie op over de presets die beschikbaar zijn. De volgende informatie komt terug:
  • Naam preset
  • IDnumber van preset - dit gebruik je om gebruikers aan te melden en/of af te melden op preset.


Deze waardes zou je bij voorkeur willen opslaan in je database, zodat je niet elke keer hoeft op te vragen. Je zou een taak kunnen laten draaien die elke x keer deze functie draait om informatie in je applicatie bij te werken.
Parameter Type Description Sample data
wstoken string required Moodle API generated token (API_token_here)
wsfunction string required Function name local_coursereport_get_presets

local_coursereport_add_users_to_preset
 Hiermee meld je een gebruiker aan op een preset.

Let op: de gebruiker moet wel in de systeemrol zitten met het recht: local/coursereport:viewreportdashboardpreset 
Parameter Type Description Sample data
wstoken string required Moodle API generated token (some_token_here)
wsfunction string required Function name local_coursereport_add_users_to_preset
presetidnumber string required Preset ID number ID number correseponding to the ID number for the preset as set in Moodle
userids string optional Comma seperated user id's Moodle userids: "2, 4, 19, 81, 114, 5461, ..."
usernames string optional Comma seperated usernames Moodle usernames: "user_1, user_2, ..."
useremailaddresses string optional Comma seperated emailaddresses Moodle emailaddresses: "user_1@moodle.org, user_2@moodle.org, ..."
Je kunt kiezenuit userids, usernames,useremailaddresses met andere woorden je hoeft maar 1 waarde te gebruiken
local_coursereport_remove_users_from_preset
 Hiermee verwijder je gebruiker op een preset.

Let op: de gebruiker moet wel in de systeemrol zitten met het recht: local/coursereport:viewreportdashboardpreset
Parameter Type Description Sample data
wstoken string required Moodle API generated token (some_token_here)
wsfunction string required Function name local_coursereport_remove_users_from_preset
presetidnumber string required Preset ID number ID number correseponding to the ID number for the preset as set in Moodle
userids string optional Comma seperated user id's Moodle userids: "2, 4, 19, 81, 114, 5461, ..."
usernames string optional Comma seperated usernames Moodle usernames: "user_1, user_2, ..."
useremailaddresses string optional Comma seperated emailaddresses Moodle emailaddresses: "user_1@moodle.org, user_2@moodle.org, ..."
Je kunt kiezen uit userids, usernames,useremailaddresses met andere woorden je hoeft maar 1 waarde te gebruiken


Was dit antwoord nuttig?