Local Definum : Extraction statistiques et services Definum : Guide technique

Accès au service

Les statistiques sont accessibles via une URL REST sur l'API de services Moodle. Une authentification par token est utilisée et doit être mise en place dans le Moodle contacté.

Le forme de la requête à utiliser est :

https://<moodlewwwroot>/webservice/rest/server.php?wstoken=<token>&wsfunction=definum_get_stats&useridfield=<useridfield>&userid=<userid>

où

wstoken : est le token d'autorisation d'accès mis en place par l'administrateur

useridfield : est le nom du champ d'identité de référence

userid : est la valeur du champ d'identité, dépendant du choix ci-dessus

Valeurs possibles pour "useridfield"

id : identifiant interne Moodle

username : Nom du'itlisateur moodle

idnumber : Numéro d'identification de l'utilisateur (s'il est provisionné)

email : Pour les plates-formes authentifiant sur courriel

oidcuniqid : l'identifiant unique OpenID Connect pour les utilisateurs provisionnés par une source OpenID.

oidcusername : Le nom d'utilisateur OpenID Connect pour les utilisateurs provisionnés par une source OpenID.

Données transmises

'id' => new external_value(PARAM_INT, 'userid'),
'lastname' => new external_value(PARAM_TEXT, 'User last name'),
'firstname' => new external_value(PARAM_TEXT, 'User first name'),
'courses' => new external_value(PARAM_INT, 'Number of enrolled courses'),
'finishablecourses' => new external_value(PARAM_INT, 'Courses enrolled having completion enabled'),
'finishedcourses' => new external_value(PARAM_INT, 'Finished courses'),
'finishedcoursesratio' => new external_value(PARAM_INT, 'Finished courses in percent'),
'badges' => new external_multiple_structure(
new external_single_sructure([
'id' => new external_value(PARAM_INT, 'Badge id'),
'name' => new external_value(PARAM_INT, 'Badge name'),
'issuername' => new external_value(PARAM_INT, 'Badge issuer name'),
'issuerurl' => new external_value(PARAM_INT, 'Badge issuer url'),
'issuercontact' => new external_value(PARAM_INT, 'Badge issuer contact'),
'dateissued' => new external_value(PARAM_INT, 'Badge issue date'),
'dateissuedstr' => new external_value(PARAM_INT, 'Badge issue date (readable format)'),
])
),
'numbadges' => new external_value(PARAM_INT, 'Number of acquired badges'),
'lastlogin' => new external_value(PARAM_INT, 'last login time'),
'lastloginstr' => new external_value(PARAM_TEXT, 'last login time (readable text formatted)'),
'timespentinmonth' => new external_value(PARAM_INT, 'time spent in seconds from the month start (1st of month)'),
'timespentinmonthstr' => new external_value(PARAM_TEXT, 'Time spent (readable text formatted)'),
'loginsinmonth' => new external_value(PARAM_INT, 'Number of connections from the start of month')

Retour à l'index du plugin deffinum - Retour à l'index des plugins