local_ltncresults_get_course_data : Realtime informatie
Welke informatie kan ik ophalen?
We maken onderscheid tussen standaard en extra informatie velden. In de bijlage vind je uitgebreide omschrijving van deze velden.
Wat wordt bedoeld met “real-time”
De LT&C API werkt met verplichte parameters voor een FROM en TO tijdstempel. Deze tijdstempel geeft een datum en tijd reeks aan waarbinnen de webservices Moodle records terugkomen. De tijdstempel (informatieveld: Triggertime) wordt door een Moodle taak bijgewerkt wanneer een gebruiker voldoet aan een van de vijf onderstaande events/triggers.
- Het moment waarop de gebruiker is aangemeld in de cursus.
- Het moment waar de gebruiker voor het eerst in de cursus gaat.
- Elke keer wanneer een gebruiker de cursus opnieuw bezoekt.
- Elke keer wanneer het cursustotaal cijfer in het Moodle cijferboek wordt bijgewerkt.
- Het moment waarop de gebruiker de cursus heeft voltooid aan de hand van ingestelde cursusvoltooiingscriteria.
Welke parameters zijn er:
Zoals aangegeven haal je de informatie op, op basis van een opgegeven parameter velden. Hieronder vind je een overzicht van onze parameter velden. Let goed op, niet alle parameters zijn verplicht en sommige parameters geeft de mogelijkheid om meer format velden te tonen.
Parameter
Voorbeeld
Type
Omschrijving
wstoken
string required
Moodle API generated token
Moodle webservice token.
wsfunction
string required
local_ltncresults_get_course_data
from
integer (unix timestamp) required
Filters from this timestamp the triggertime*
1577836800
to
integer (unix timestamp) required
Filters till this timestamp the triggertime
1633608017
categoryidnumber
string required
Filters only returns category -> idnumber linked courses
Bijvoorbeeld: procurax56
Let op: in moodle staat dan procurax56/01
auth
string optional
authenticatiemethode comma seperated (bv manual,lti)
ltnc_fields
string optional
CSV formated extra fields, comma sepated *
firstname,
lastname,
useridnumber,
customprofilefields,
enrolment_timecreated,
enrolment_timefirstaccesscourse, course_completions_percentage,
attempts_count,attempts_quizes, timeend
userid
integer optional
Moodle User ID
Waarde Moodle UserID
moodlewsrestformat
string optional
Allow returning in JSON format
json
Waar moet je rekening mee houden
Doordat we informatie “real-time” ophalen en zelf niet opslaan, maakt het ook dat de derde partij die de informatie verantwoordelijk is voor het eventuele bewaren van opgevraagde informatie.
Hieronder vind je een aantal scenario’s die er voor kunnen zorgen dat in eens informatie niet mee opgehaald kan worden.
Scenario
Gevolg
1.
Cursist wordt afgemeld op een cursus.
De API geen informatie meer aanlevert over de cursist in de cursus.
2.
Cursus wordt verwijderd.
De API levert geen informatie meer de cursus en de cursisten die erin stonden.
3.
De LTI koppeling wordt verwijderd.
De API geen informatie meer aanlevert over de cursist in de cursus.
4
De behaalde cijferresultaten worden verwijderd en/of aangepast.
Het behaalde cijfer in informatieveld “Course grade” wordt gewijzigd.
5
De cursus wordt verschoven naar een andere categorie.
De cursus informatie is niet meer op te roepen door de webservice óf er moet een andere categorieid worden opgegeven.
6
Activiteit -of cursusvoltooiing wordt gereset.
De API zal de geen en/of nieuwe datum van afronding doorgeven.
7
Activiteiten worden verwijderd.
Dit kan impact hebben op het cijfer bij “Course grade” en/of “Course_timecompleted”
Overzicht informatievelden
In het onderstaande overzicht krijg je een beeld van de velden die de LT&C Resultaten API kan opleveren.
Wanneer in het overzicht een “JA” staat bij LTNC fields, dan wordt dit informatieveld alleen getoond als je dit opgeeft in de parameter.
Wanneer in het overzicht een waarde staat bij Trigger, dan wordt de waarde in dit veld gewijzigd op basis van de eerder omschreven events/triggers.
Veld benaming
Beschrijving
LNTC_FIELDS
Trigger
Triggertime
Dit veld toont de datum en tijd dat de informatie voor het laatst is bijgewerkt in de volgende notaties: dd-mm-yyyyy hh:mm
Nee
1 t/m 5
Userid
Het Moodle User ID
Nee
Firstname
Voornaam
Ja
Lastname
Achternaam
Ja
Email
E-mailadres
Ja
Useridnumber
Moodle UserIDnumber
Ja
Customprofilefield_xx
Toont de waarde van elk custom profielveld dat is ingesteld in de omgeving
Ja
Courseid
Het Moodle cursus ID
Nee
Category_idnumber
Omdat te zorgen dat de API alleen informatie stuurt naar een derde systeem waar dit relevant voor is. Moet er een category ID number worden meegeven. In het Category IDnumber een / teken worden toegevoegd om te zorgen dat een derde partij data kan ophalen uit meerdere categorieën.
Nee
Course_fullname
De volledige naam van de cursus
Nee
Enrolment_timecreated
De datum en het tijdstip waarop een cursist is aangemeld op de cursus. Notatie: dd-mm-yyyy hh:mm
Ja
1
Enrolment_timefirstaccesscourse
De eerste keer dat een cursist toegang heeft tot de cursus.
Notatie: dd-mm-yyyy hh:mm
Ja
2
enrolment_timeend
De datumt waarop de aanmelding beëindigd
notatie: dd-mm-yyyy hh:mm
ja
1
Course_timelastaccess
De laatste keer datum en tijd laatste toegang
Notatie: dd-mm-yyyy hh:mm
Wanneer iemand nog niet in de cursus is geweest is dit veld leeg.
Nee
3
Course_timecompleted
De datum en het tijdstip waarop de cursist in Moodle de cursusvoltooiing criteria heeft gehaald.
Notatie: dd-mm-yyyy hh:mm
Nee
5
Course_grade
Hier komt het cursuscijfer te staan dat in het Moodle puntenboek bij Course Totaal staat.
Nee
Course_timegrademodified
Dit is de datum en het tijdstip waarop het cursus totaal cijfer voor het laatst is bijgewerkt.
Notatie: dd-mm-yyyy hh:mm
Ja
4
Course_completion_percentage
Geeft een numerieke waarde door t.a.v. de cursus voltooiing percentage. Het percentage wordt berekend op basis van het aantal activiteiten die de voltooiing instelling aan hebben staan.
Ja
5
Attempts_count
Het totaal aantal toetspogingen van de Moodle toets Activiteiten die geselecteerd staan bij cursusvotlooiing.
Ja
4
Attempts_quizes
Het aantal toetspogingen van een Moodle toets activiteit, van de geselecteerde toetsen bij cursusvoltooiing.
Ja
4
Van elke poging wordt de onderstaande informatie getoond.
Name
Activiteit naam toets
Attempt_ID
Poging ID
Attempt_number
Nummer van de poging
Timestart
De datum waarop de poging gestart is door de cursist.
State
De state dat eindtoets heeft in Moodle.
- In progress = Bezig
- Finished = Afgerond
Grade
Het resultaat dat is gehaald voor deze poging.
Mis je velden?
Mis je informatie velden die voor jullie organisatie en/of derde partij belangrijk is? Geen enkel probleem! Laat het ons even weten, en we kijken en denken graag met je mee. Hou wel rekening met ontwikkelkosten!