Schnittstelle ONYX Editor
Ergebnisse speichern
Der ONYX Editor kann Tests für eine freie Durchführung publizieren. Führen Nutzer diese Tests durch, wird das Ergebnis zurück an den ONYX Editor übertragen, welcher es speichert. Dazu bietet der ONYX Editor folgende REST-Schnittstellen an:
public Boolean saveResult(
@RestParam(name = "uniqueId") final String uniqueId,
@RestParam(name = "resultFile") final byte[] resultFile,
@RestParam(name = "params") final Map<String, String> params) {}
Parameter saveResult2
uniqueId | Eindeutige ID, die ONYX WebPlayer und ONYX Editor bei der Ausführung des Tests vereinbart haben |
resultFile | Ergebnis-Datei als ZIP-File (QTI-konformes result.xml, ggf. inkl. darin referenzierter Dateien wie User-Uploads oder User-Contents |
params | Generische Parameter. Diese werden aktuell ohne weitere Verarbeitung einfach nur gespeichert. |
returnValue saveResult2
boolean | True bei Erfolg, sonst false |
Ergebnisse speichern (Legacy)
public Boolean saveResult(
@RestParam(name = "uniqueId") final String uniqueId,
@RestParam(name = "resultFile") final byte[] resultFile) {}
Parameter saveResult2
uniqueId | Eindeutige ID, die ONYX WebPlayer und ONYX Editor bei der Ausführung des Tests vereinbart haben |
resultFile | Ergebnis-Datei als ZIP-File (QTI-konformes result.xml, ggf. inkl. darin referenzierter Dateien wie User-Uploads oder User-Contents |
returnValue saveResult2
boolean | True bei Erfolg, sonst false |
Version der Schnittstelle abfragen
public String version() {}
Parameter version
keine
returnValue saveResult2
String | Version der REST-Schnittstelle, aktuell immer "1.0 (ONYX-Editor-Version)" |
Nutzer löschen
Der ONYX Editor kann an ein LMS gekoppelt werden, so dass das LMS das nutzerdatenführende System ist. Werden Nutzer im LMS gelöscht, so sollten alle zugehörigen Daten (bspw. die persönlichen Einstellungen des Nutzers) auch im ONYX Editor gelöscht werden.
public Map<String, String> deleteUser(
@RestParam(name = "login") final String login,
@RestParam(name = "password") final String password,
@RestParam(name = "repo") final String repo,
@RestParam(name = "property") final String property,
@RestParam(name = "values") final ArrayList<String> values,
@RestParam(name = "reason") final String reason,
@RestParam(name = "params") final Map<String, String> params) {}
Parameter deleteUser
login | Username eines ONYX-Editor-Admin-Nutzers, der das Recht hat, andere Nutzer zu löschen. |
password | Passwort dieses ONYX-Editor-Admin-Nutzers. |
repo | ID des LMS-Repositories, so wie diese im LMS bereits konfiguriert ist und zur Kommunikation mit dem ONYX Editor verwendet wird |
property | Selektionskriterium der zu löschenden Nutzer. Wenn "uid", dann wird nach dem gloabl gültigem Nutzer-Identifier (Shibboleth-Kriterium) gefiltert, sonst nach den Nutzernamen, die vom LMS in Verbindung mit dem ONYX Editor intern genutzt werden. |
values | Liste der Werte, nach denen gefiltert wird, bspw. Liste der Nutzernamen. |
reason | Lösch-Grund. Wird mit ins Lösch-Log geschrieben. |
params | Aktuell nicht genutzt |
returnValue deleteUser
Löschresultat-Informationen.
Key | Die Values, wie im Parameter _values_ angegeben |
Value | Löschresultat (bspw. _NOT FOUND_, _ERROR:xyz_, ...) |