Zum Inhalt springen

Änderungen von Dokument 06 Schnittstelle ONYX Editor

Zuletzt geändert von Carina Enke am 13.02.2024
Von Version 96.1
bearbeitet von Carina Enke
am 13.02.2024
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 89.3
bearbeitet von Carina Enke
am 18.12.2023
Änderungskommentar: Update document after refactoring.

Zusammenfassung

Details

Seiteneigenschaften
Titel
... ... @@ -1,1 +1,1 @@
1 -05 Schnittstelle ONYX Editor
1 +Schnittstelle ONYX Editor
Übergeordnete Seite
... ... @@ -1,1 +1,1 @@
1 -ONYX.Systeminformationen.WebHome
1 +00 Onyx.Hilfe.Systeminformationen.WebHome
Inhalt
... ... @@ -1,13 +1,24 @@
1 +{{sv-translation language="de"}}
1 1  {{layout}}
3 +{{layout-section ac:type="single"}}
4 +{{layout-cell}}
5 +\\
6 +{{/layout-cell}}
7 +{{/layout-section}}
8 +
2 2  {{layout-section ac:type="two_right_sidebar"}}
3 3  {{layout-cell}}
4 -
11 +\\
5 5  {{/layout-cell}}
6 6  
7 7  {{layout-cell}}
15 +{{scroll-ignore}}
8 8  {{panel title="Inhalt"}}
9 -{{toc depth="3" start="2"/}}
17 +
18 +
19 +{{toc/}}
10 10  {{/panel}}
21 +{{/scroll-ignore}}
11 11  {{/layout-cell}}
12 12  {{/layout-section}}
13 13  
... ... @@ -25,6 +25,7 @@
25 25  @RestParam(name = "params") final Map<String, String> params) {}
26 26  {{/code}}
27 27  
39 +\\
28 28  
29 29  === Parameter saveResult2 ===
30 30  
... ... @@ -45,6 +45,8 @@
45 45  Generische Parameter. Diese werden aktuell ohne weitere Verarbeitung einfach nur gespeichert.
46 46  )))
47 47  
60 +\\
61 +
48 48  === returnValue saveResult2 ===
49 49  
50 50  (% class="wrapped" %)
... ... @@ -56,6 +56,8 @@
56 56  
57 57  == Ergebnisse speichern (Legacy) ==
58 58  
73 +\\
74 +
59 59  {{code title="Ergebnisse speichern (Legacy)"}}
60 60  @RestMethod(name = "saveResult")
61 61  public Boolean saveResult(
... ... @@ -63,6 +63,7 @@
63 63  @RestParam(name = "resultFile") final byte[] resultFile) {}
64 64  {{/code}}
65 65  
82 +\\
66 66  
67 67  === Parameter saveResult2 ===
68 68  
... ... @@ -87,18 +87,24 @@
87 87  True bei Erfolg, sonst false
88 88  )))
89 89  
107 +\\
108 +
90 90  == Version der Schnittstelle abfragen ==
91 91  
111 +\\
112 +
92 92  {{code title="Version abfragen"}}
93 93  @RestMethod(name = "version")
94 94  public String version() {}
95 95  {{/code}}
96 96  
118 +\\
97 97  
98 98  === Parameter version ===
99 99  
100 100  keine
101 101  
124 +\\
102 102  
103 103  === returnValue saveResult2 ===
104 104  
... ... @@ -109,6 +109,8 @@
109 109  Version der REST-Schnittstelle, aktuell immer "1.0 (ONYX-Editor-Version)"
110 110  )))
111 111  
135 +\\
136 +
112 112  == Nutzer löschen ==
113 113  
114 114  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.
... ... @@ -182,3 +182,202 @@
182 182  {{/layout-cell}}
183 183  {{/layout-section}}
184 184  {{/layout}}
210 +{{/sv-translation}}
211 +
212 +{{sv-translation language="en"}}
213 +{{layout}}
214 +{{layout-section ac:type="two_right_sidebar"}}
215 +{{layout-cell}}
216 +\\
217 +{{/layout-cell}}
218 +
219 +{{layout-cell}}
220 +{{scroll-ignore}}
221 +{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Content"}}
222 +
223 +
224 +{{toc/}}
225 +{{/panel}}
226 +{{/scroll-ignore}}
227 +{{/layout-cell}}
228 +{{/layout-section}}
229 +
230 +{{layout-section ac:type="single"}}
231 +{{layout-cell}}
232 +== Save results ==
233 +
234 +With the ONYX Editor, system independent tests may be published. If users perform these tests, the result will be transferred back to the ONYX Editor, which saves it. The ONYX Editor provides the following REST interfaces:
235 +
236 +{{code title="Save results"}}
237 +@RestMethod(name = "saveResult2")
238 +public Boolean saveResult(
239 +@RestParam(name = "uniqueId") final String uniqueId,
240 +@RestParam(name = "resultFile") final byte[] resultFile,
241 +@RestParam(name = "params") final Map<String, String> params) {}
242 +{{/code}}
243 +
244 +\\
245 +
246 +=== Parameter saveResult2 ===
247 +
248 +|(((
249 +uniqueId
250 +)))|(((
251 +Unique ID used by the ONYX WebPlayer and ONYX Editor when running the test.
252 +)))
253 +|(((
254 +resultFile
255 +)))|(((
256 +Result file as ZIP file (QTI-compliant result.xml, including any referenced files such as user uploads or user content if necessary)
257 +)))
258 +|(((
259 +params
260 +)))|(((
261 +Generic parameters. These are currently only stored without further processing.
262 +)))
263 +
264 +\\
265 +
266 +=== returnValue saveResult2 ===
267 +
268 +|(((
269 +boolean
270 +)))|(((
271 +True if successful, otherwise false
272 +)))
273 +
274 +== Save results (legacy) ==
275 +
276 +\\
277 +
278 +{{code title="Save results (legacy)"}}
279 +@RestMethod(name = "saveResult")
280 +public Boolean saveResult(
281 +@RestParam(name = "uniqueId") final String uniqueId,
282 +@RestParam(name = "resultFile") final byte[] resultFile) {}
283 +{{/code}}
284 +
285 +\\
286 +
287 +=== Parameter saveResult2 ===
288 +
289 +|(((
290 +uniqueId
291 +)))|(((
292 +Unique ID used by the ONYX WebPlayer and ONYX Editor when running the test.
293 +)))
294 +|(((
295 +resultFile
296 +)))|(((
297 +Result file as ZIP file (QTI-compliant result.xml, including any referenced files such as user uploads or user content if necessary)
298 +)))
299 +
300 +=== returnValue saveResult2 ===
301 +
302 +|(((
303 +boolean
304 +)))|(((
305 +True if successful, otherwise false
306 +)))
307 +
308 +\\
309 +
310 +== Query interface version ==
311 +
312 +\\
313 +
314 +{{code title="Query version"}}
315 +@RestMethod(name = "version")
316 +public String version() {}
317 +{{/code}}
318 +
319 +\\
320 +
321 +=== Parameter version ===
322 +
323 +None
324 +
325 +\\
326 +
327 +=== returnValue saveResult2 ===
328 +
329 +|(((
330 +String
331 +)))|(((
332 +REST interface version, currently always "1.0 (ONYX Editor version)"
333 +)))
334 +
335 +\\
336 +
337 +== Delete user ==
338 +
339 +The ONYX Editor can be coupled to an LMS with the LMS being the user data management system. If users are deleted from the LMS, all related data (e. g. personal user settings) should also be deleted from the ONYX Editor.
340 +
341 +{{code title="Delete user"}}
342 +@RestMethod
343 +public Map<String, String> deleteUser(
344 + @RestParam(name = "login") final String login,
345 + @RestParam(name = "password") final String password,
346 + @RestParam(name = "repo") final String repo,
347 + @RestParam(name = "property") final String property,
348 + @RestParam(name = "values") final ArrayList<String> values,
349 + @RestParam(name = "reason") final String reason,
350 + @RestParam(name = "params") final Map<String, String> params) {}
351 +{{/code}}
352 +
353 +=== Parameter deleteUser ===
354 +
355 +|(((
356 +login
357 +)))|(((
358 +User name of an ONYX Editor admin user who has the right to delete other users.
359 +)))
360 +|(((
361 +password
362 +)))|(((
363 +Password of this ONYX Editor admin user.
364 +)))
365 +|(((
366 +repo
367 +)))|(((
368 +ID of the LMS repository as it is already configured in the LMS and used for communication with the ONYX Editor.
369 +)))
370 +|(((
371 +property
372 +)))|(((
373 +Selection criterion for the users to be deleted. If "uid", filtering is done according to the globally valid user identifier (Shibboleth criterion). Otherwise, the filtering is done according to the user names used internally by the LMS in conjunction with the ONYX Editor.
374 +)))
375 +|(((
376 +values
377 +)))|(((
378 +List of values to filter by, for example, list of user names.
379 +)))
380 +|(((
381 +reason
382 +)))|(((
383 +Reason for deletion. Will be included in the deletion log.
384 +)))
385 +|(((
386 +params
387 +)))|(((
388 +Currently not used
389 +)))
390 +
391 +=== returnValue deleteUser ===
392 +
393 +Deletion result information.
394 +
395 +|(((
396 +Key
397 +)))|(((
398 +The values as specified in the _values_ parameter
399 +)))
400 +|(((
401 +Value
402 +)))|(((
403 +Deletion result (e. g _NOT FOUND_, _ERROR:xyz_, ...)
404 +)))
405 +{{/layout-cell}}
406 +{{/layout-section}}
407 +{{/layout}}
408 +{{/sv-translation}}