cbluesprl / moodle-mod_hva

Designed and developed in partnership between Cblue and Hyperfiction, this plug-in allows you to connect any thick client application running on any type of device (PC, smartphone, virtual reality headset, etc.) to the Moodle platform via Web Services.
0 stars 0 forks source link

mod_hva

Nom du pluggin : "Hyperfiction VR Activity"

Installation

Deux méthodes d'installation sont disponibles. Suivez l'une d'entre elles, puis connectez-vous à votre site Moodle en tant qu'administrateur et visitez la page des notifications pour terminer l'installation.

GIT

Cela nécessite que Git soit installé. Si vous n'avez pas installé Git, veuillez visiter le site web de Git. Une fois Git installé, rendez-vous simplement dans votre répertoire Moodle mod et clonez le dépôt en utilisant la commande suivante.

git clone https://github.com/cbluesprl/moodle-mod_hva.git hva

Ou ajoutez-le avec la commande submodule si vous utilisez des submodules.

git submodule add https://github.com/cbluesprl/moodle-mod_hva.git mod/hva

Download the zip

Visitez le site web des plugins Moodle et téléchargez le zip correspondant à la version de Moodle que vous utilisez. Extrayez le zip et placez le dossier 'hva' dans le dossier mod de votre répertoire Moodle.

Dépendances

aucune

Pré-requis

Vous devez activer web service REST de votre plateforme pour utiliser ce plugin et paramètrer un token pour les webservice du plugin Hyperfiction VR Activity.

Vous pouvez retrouver la documentation nécessaire à cela sur :

https://docs.moodle.org/400/en/Using_web_services

ou les étapes à suivre :

https://docs.moodle.org/19/en/How_to_enable_web_services_for_ordinary_users

ou suivre le procédé "Autoriser un système externe à contrôler Moodle" disponible à cet endroit de votre moodle :

https://votre_moodle/admin/settings.php?section=webservicesoverview

Test

Une page de test est accessible aux managers avec la capability suivante : 'mod/hva:test' .

Webservices

Ce plugin fonctionne avec 2 webservice :

get_info

/webservice/rest/server.php?wstoken=token&wsfunction=mod_hva_get_info&moodlewsrestformat=json

Il faut fournir le paramètre suivant : pincode : le code pin de l'étudiant au lancement de l'activité.

Exemple d'URL complet :

http://grtgaz.local73/webservice/rest/server.php?wstoken=dd315c54548c8ef9b1238b11111b27c3&wsfunction=mod_hva_get_info&moodlewsrestformat=json&pincode=6474

Voici un exemple de json que doit retourner le ws :

{
  "studentId": 2,
  "studentName": "Nom Prénom",
  "activityTitle": "activité de test",
  "LMSTracking": {
    "score": 88,
    "completion": "3"
  },
  "hyperfictionTracking": "{\"valeur\":1,\"valeur\":2}",
  "url": "http://plateforme/webservice/pluginfile.php/73/mod_hva/zipfile/1/nom_du_fichier.zip?token=dd315c54548c8ef9b1238b11111b27c3"
}

Le tracking json retourner est en string.

save_data

/webservice/rest/server.php?wstoken=token&wsfunction=mod_hva_get_info&moodlewsrestformat=json

Ce web service retourne le status 'save succeeded' si la sauvegarde à fonctionner sinon retourne le status 'Can't find data record in database table hva.' si le code pin est erroné.

Il faut fournir les paramètres :

Exemple d'URL complet :

/webservice/rest/server.php?wstoken=dd315c54548c8ef9b1238b11111b27c3&wsfunction=mod_hva_save_data&moodlewsrestformat=json&pincode=6474&LMSTracking[score]=88&LMSTracking[completion]=completed&hyperfictionTracking={"valeur":1,"valeur":2}

Si le webservice à fonctionner, vous recevez un json avec ce status :

{
  "status": "save succeeded"
}