Avendoo® Online Hilfe

Avendoo® API

Wissenstest-Endseiten

Erfahrene Autoren (mit entsprechenden HTML/CSS und JavaScript Kenntnissen) können für die Endseite eines Wissenstests auf die Avendoo® API (application programming interface) zurückgreifen und so bestimmte Parameter an ein eigenständig erstelltes Design übergeben.

Die nachfolgende Tabelle enthält den entsprechenden Befehl und die jeweilige Erklärung:

BefehlErklärung

window.top.

Wenn der Inhalt der Wissenstest Endseite mit Hilfe eines IFrames eingebunden wird, muss diese Angabe vor jede Funktion gesetzt werden, um aus dem Iframe heraus auf die Funktion in der Avendoo-API zuzugreifen.

var login

Die Variable enthält den Benutzernamen des Benutzers.

var sequencePassed

Die Variable enthält die Information, ob der Benutzer den Wissenstest bestanden hat.

true = Bestanden
false = Nicht bestanden

Hinweis: Das Element „Zusammenfassung“ muss eingefügt sein.

var sequencePoints

Die Variable enthält die Punkte, die zum Bestehen des Wissenstests erforderlich sind.

var sequencePossible
Points

Die Variable enthält die maximal erreichbaren Punkte im Wissenstest.

var sequenceReached
Points

Die Variable enthält die erreichte Punktzahl des Benutzers im Wissenstest.

fn_getPerformanceBarData()

Mit dieser Funktion wird ein Objekt performanceBarData erzeugt und als JSON String übergeben. Das Objekt hat folgende Attribute:

  • performanceBarData.reachedPoints = Tatsächlich erreichte Gesamtpunktzahl des Benutzers im Wissenstest
  • performanceBarData.maxPoints = maximal erreichbare Gesamtpunktzahl im Wissenstest
  • performanceBarData.minPoint = Bestehensgrenze des Wissenstests
  • performanceBarData.userAverage = Durchschnittliche Gesamtpunktzahl der Ergebnisse aller Benutzer
  • performanceBarData.numberOfResults = Anzahl der Wissenstest-Teilnahmen, bei denen der Test abgeschlossen wurde.
  • performanceBarData.stdReachedPoints = Standardabweichung der erreichten Gesamtpunktzahl
  • performanceBarData.averageMaxPoints = Mittelwert für die maximale Punktzahl aller Fragen (relevant für Wissenstests mit zufälliger Fragenauswahl)
  • performanceBarData.stdMaxPoints = Standardabweichung für die maximale Punktzahl aller Fragen (relevant für Wissenstests mit zufälliger Fragenauswahl)

Hinweis:

Auf dem Reiter „Endseite“ des Wissenstests muss der Bereich eingefügt sein.
Beispiel:
Nachfolgend wird das JSON Objekt erzeugt und anschließend das Attribut numberOfResults als Alert-Meldung ausgegeben:
obj = JSON.parse(fn_getPerformanceBarData());
alert(obj.numberOfResults);

fn_getQuestionDetailData()

Mit dieser Funktion wird ein Array questionDetailData erzeugt und als JSON String übergeben. Pro Frage des Wissenstests wird ein Objekt erzeugt.

Jedes einzelne Objekt enthält folgende Attribute:

  • question.questionId = ID der Frage in Avendoo® (z.B. 1361346442146_1)
  • question.averageReachedPoints = Durchschnitt der durch die bisherigen Teilnehmer erreichten Punkte zu jeder Frage
  • question.standardDeviationReachedPoints = Standardabweichung der erreichten Punkte der bisherigen Teilnehmer zu jeder Frage
  • question.maxPoints = maximal erreichbare Punktzahl einer Frage
  • question.reachedPoints = tatsächlich erreichte Punktzahl des Benutzers einer Frage
  • question.position = Position einer Frage im Wissenstest
  • question.type = Fragetyp
  • question.title = Titel einer Frage

Mit obj = JSON.parse(fn_ getQuestionDetailData); kann ein Objekt erzeugt werden und dann mit obj[0].questionId usw. auf die einzelnen Attribute der Fragen zugegriffen werden.

Hinweis:

  • Im Tab „Endseite“ bei „Anzeige der Details“ muss etwas anderes als „Keine Details“ gewählt sein. Ansonsten werden die vorgenannten Daten nicht geschrieben.
  • Die Positionen im Array werden ab „0“ gezählt und in eckige Klammern geschrieben.
  • Im Tab „Endseite“ bei „Anzeige der Details“ muss etwas anderes als „Keine Details“ gewählt sein. Ansonsten werden die vorgenannten Daten nicht geschrieben.

Beispiele:
Nachfolgend wird das JSON Objekt erzeugt und anschließend das Attribut title für die 1. Frage im Wissenstest als Alert-Meldung ausgegeben:

 obj = JSON.parse(fn_getQuestionDetailData());
alert(obj[0].title));

Das nächste Beispiel zeigt die erreichte Punktzahl des Benutzers für die zweite Frage im Wissenstest:

obj = JSON.parse(fn_getQuestionDetailData());
alert(obj[1].reachedPoints));

fn_getSequenceData()

Diese Methode gibt ein Array zurück, welches alle Wissenstests beinhaltet, die mindestens einmal abgeschlossen wurden und über diese API angezeigt werden dürfen.
Angezeigt werden darf ein Wissenstest nur dann, wenn er den Typ „Übung“ und nicht „Prüfung“ hat.
Hier enthalten sind:
Titel
Teaser
Wissenstest ID
aufgewendete Zeit (Long-Wert)
erreichte Punkte
maximale Punkte
Erreichte Prozent
Datum des Abschlusses (Long-Wert)