Introductie
Om Coachview toegang via webservices te verlenen zijn de volgende instellingen in Moodle van belang. Als je als administrator bent ingelogd kun je met de URL (zie in de tabel de laatste kolom) direct naar de pagina in Moodle springen om de verschillende gegevens in te richten. Bijvoorbeeld: https://moodle.coachview.net/admin/settings.php?section=webserviceprotocols.

Support/getest tot versie 2.9 (let op de schermen 3.0 en hoger kunnen afwijken). Via 'Site-administration' en 'Registrations' kun je jouw Moodle versie controleren.


Instellen Moodle:
Instelling
Waarde
URL
Enable web services
yes
/admin/search.php?query=enablewebservices

Enable protocols
Enable ‘REST protocol’
/admin/settings.php?section=webserviceprotocols

Gebruikersaccount aanmaken.
Klik op de knop 'Toevoegen'.

Gebruikersnaam = ws_coachview.net
Authenticatie methode = Webservice authenticatie
Voornaam: Webservice (= voorbeeld)
Achternaam: Coachview (= voorbeeld)
E-mailadres: test@coachview.net (= voorbeeld)

Klik op 'Maak gebruiker'.
/admin/user.php

Gebruikersrol aanmaken met rechten
Klik op 'Nieuwe rol toevoegen'.

Gebruik rol voor archetype = 'Geen rol'.

Klik op 'Ga door'.
 
Korte naam = ws_coachviewrol
Aangepast volledige naam = Coachview webservice rol
Contexttypes waarin deze rol mag toegewezen worden = systeem aanvinken
Toewijzen van rollen toestaan = Leerling (anders kun je gebruiker niet enrolen als student)

Scroll naar beneden en vul in bij 'Filter' een voor een onderstaande onderdelen.
Let op: de filter start automatisch, klik niet op enter.

  1. enrol/manual:enrol  -> Gebruikers aanmelden; toelaten aanvinken
  2. enrol/manual:unenrol -> Gebruikers van de cursus afmelden; toelaten aanvinken
  3. moodle/cohort:assign -> Site groepsleden toevoegen en verwijderen; toelaten aanvinken
  4. moodle/user:create -> Gebruikers aanmaken; toelaten aanvinken
  5. moodle/user:viewdetails -> Gebruikersprofielen bekijken; toelaten aanvinken
  6. moodle/user:viewalldetails -> Bekijk alle informatie van de gebruiker; toelaten aanvinken
  7. moodle/user:viewhiddendetails -> Verborgen details van gebruikers bekijken; toelaten aanvinken
  8. moodle/site:viewuseridentity -> Bekijk de volledige gebruikersidentiteit in lijsten; toelaten aanvinken
  9. moodle/course:useremail -> Inschakelen/uitschakelen e-mailadressen; toelaten aanvinken
  10. moodle/user:update -> Gebruikersprofielen updaten; toelaten aanvinken
  11. moodle/course:view -> Cursussen zien zonder deel te nemen; toelaten aanvinken
  12. moodle/role:assign -> Toewijzen van rollen aan gebruikers; toelaten aanvinken
  13. webservice/rest:use -> Gebruik REST protocol; toelaten aanvinken

Klik op 'Bewaar de wijzigingen'.

Niet nodig: moodle/user:delete, moodle/cohort:view, moodle/course:viewparticipants,
/admin/roles/manage.php

Show user identity (showuseridentity)
rechten aanpassen
Toon de identiteit van de gebruiker = Nummer (ID) aanvinken.
Klik op 'Bewaar wijzigingen'.

Hiermee wordt een deelnemer uit Coachview in Moodle geïdentificeerd.

/admin/settings.php?section=userpolicies
Gebruikersrol koppelen aan Gebruikersaccount
Klik op de naam 'Coachview webservice role'. Dit is onder 'Gebruikersrol aanmaken met rechten' de naam die is ingevuld bij 'Aangepast volledige naam'.

Selecteer 'Webservice Coachview' en klik op 'Voeg toe'.
/admin/roles/assign.php?contextid=1

Nieuwe Custom (web)service aanmaken en koppelen van webservice functies
Klik op 'Voeg toe'.

Naam = Coachview webservice
Korte naam = ws_coachview
Ingeschakeld = aanvinken
Enkel geauthoriseerde gebruikers = aanvinken

Klik op 'Voeg service toe'.
/admin/settings.php?section=externalservices


Klik in de tabel op 'Functies'.
Klik op 'Functies toevoegen'.

Vul een voor een de volgende onderdelen in bij 'Zoek' en klik telkens op <enter> om deze toe te voegen.
  1. core_cohort_add_cohort_members 
  2. core_cohort_delete_cohort_members
  3. core_user_create_users
  4. core_user_get_users_by_field
  5. core_user_update_users
  6. enrol_manual_enrol_users (niet beschikbaar in oudere Moodle versies)

Klik op 'Functies toevoegen'.


Gebruikersaccount koppelen aan nieuwe webservice
Klik in dezelfde tabel op 'Geauthoriseerde gebruikers'.
Selecteer 'Webservice Coachview' en klik op 'Voeg toe'.
/admin/settings.php?section=externalservices
Token aanmaken voor het gebruikersaccount.
Klik op 'Voeg toe' en vul het volgende in:

Gebruiker (selecteer uit de lijst):
Webservice Coachview
Service (selecteer uit de lijst):
Coachview webservice
IP beperking:
  • Voor Coachview training: 212.83.209.208
  • Voor Coachview live: 212.83.209.198.
Geldig tot:
niet activeren.

Klik op 'Bewaar de wijzigingen'.

Token retourneren naar Coachview of via Service center in Coachview toevoegen.

Debug messages aanzetten
Debug messages: none -> Developer (/admin/settings.php?section=debugging)
/admin/settings.php?section=webservicetokens
Extra customerfields instellen. Deze kun je gebruiken om informatie uit vrije velden, vastgelegd in het persoonsdossier in Coachview, weer te geven.
Maak daar een profile field aan van het type 'text input'.
Vul bij shortname de Coachview vrijveldcode in (=voorkeur). of kies een eigen code/naam en vul dezelfde code/naam.
In het Service Center van Coachview kun je instellen welke gegevens overgezet moeten worden.
/user/profile/index.php
AVGHeb je vanaf Moodle versie 3.3.5 de Privacy Tool inzake GDPR/AVG ingesteld?
Dan dien je via Sitebeheer -> Privacy en beleid -> gebruikersovereenkomsten namens het webservice account toestemming (akkoord) te geven op de voorwaarden die ingesteld zijn.