Änderungen von Dokument 06 Schnittstelle ONYX Editor

Zusammenfassung

• Seiteneigenschaften (2 geändert, 0 hinzugefügt, 0 gelöscht)

Details

Seiteneigenschaften

Titel

...	...	@@ -1,1 +1,1 @@
1		-05 Schnittstelle ONYX Editor
	1	+06 Schnittstelle ONYX Editor

Inhalt

...	...	@@ -182,181 +182,3 @@
182	182	{{/layout-cell}}
183	183	{{/layout-section}}
184	184	{{/layout}}
185		-
186		-{{layout}}
187		-{{layout-section ac:type="two_right_sidebar"}}
188		-{{layout-cell}}
189		-
190		-{{/layout-cell}}
191		-
192		-{{layout-cell}}
193		-{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Content"}}
194		-{{toc start="2"/}}
195		-{{/panel}}
196		-{{/layout-cell}}
197		-{{/layout-section}}
198		-
199		-{{layout-section ac:type="single"}}
200		-{{layout-cell}}
201		-== Save results ==
202		-
203		-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:
204		-
205		-{{code title="Save results"}}
206		-@RestMethod(name = "saveResult2")
207		-public Boolean saveResult(
208		-@RestParam(name = "uniqueId") final String uniqueId,
209		-@RestParam(name = "resultFile") final byte[] resultFile,
210		-@RestParam(name = "params") final Map<String, String> params) {}
211		-{{/code}}
212		-
213		-
214		-=== Parameter saveResult2 ===
215		-
216		-|(((
217		-uniqueId
218		-)))|(((
219		-Unique ID used by the ONYX WebPlayer and ONYX Editor when running the test.
220		-)))
221		-|(((
222		-resultFile
223		-)))|(((
224		-Result file as ZIP file (QTI-compliant result.xml, including any referenced files such as user uploads or user content if necessary)
225		-)))
226		-|(((
227		-params
228		-)))|(((
229		-Generic parameters. These are currently only stored without further processing.
230		-)))
231		-
232		-=== returnValue saveResult2 ===
233		-
234		-|(((
235		-boolean
236		-)))|(((
237		-True if successful, otherwise false
238		-)))
239		-
240		-== Save results (legacy) ==
241		-
242		-{{code title="Save results (legacy)"}}
243		-@RestMethod(name = "saveResult")
244		-public Boolean saveResult(
245		-@RestParam(name = "uniqueId") final String uniqueId,
246		-@RestParam(name = "resultFile") final byte[] resultFile) {}
247		-{{/code}}
248		-
249		-
250		-=== Parameter saveResult2 ===
251		-
252		-|(((
253		-uniqueId
254		-)))|(((
255		-Unique ID used by the ONYX WebPlayer and ONYX Editor when running the test.
256		-)))
257		-|(((
258		-resultFile
259		-)))|(((
260		-Result file as ZIP file (QTI-compliant result.xml, including any referenced files such as user uploads or user content if necessary)
261		-)))
262		-
263		-=== returnValue saveResult2 ===
264		-
265		-|(((
266		-boolean
267		-)))|(((
268		-True if successful, otherwise false
269		-)))
270		-
271		-== Query interface version ==
272		-
273		-{{code title="Query version"}}
274		-@RestMethod(name = "version")
275		-public String version() {}
276		-{{/code}}
277		-
278		-
279		-=== Parameter version ===
280		-
281		-None
282		-
283		-
284		-=== returnValue saveResult2 ===
285		-
286		-|(((
287		-String
288		-)))|(((
289		-REST interface version, currently always "1.0 (ONYX Editor version)"
290		-)))
291		-
292		-== Delete user ==
293		-
294		-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.
295		-
296		-{{code title="Delete user"}}
297		-@RestMethod
298		-public Map<String, String> deleteUser(
299		- @RestParam(name = "login") final String login,
300		- @RestParam(name = "password") final String password,
301		- @RestParam(name = "repo") final String repo,
302		- @RestParam(name = "property") final String property,
303		- @RestParam(name = "values") final ArrayList<String> values,
304		- @RestParam(name = "reason") final String reason,
305		- @RestParam(name = "params") final Map<String, String> params) {}
306		-{{/code}}
307		-
308		-=== Parameter deleteUser ===
309		-
310		-|(((
311		-login
312		-)))|(((
313		-User name of an ONYX Editor admin user who has the right to delete other users.
314		-)))
315		-|(((
316		-password
317		-)))|(((
318		-Password of this ONYX Editor admin user.
319		-)))
320		-|(((
321		-repo
322		-)))|(((
323		-ID of the LMS repository as it is already configured in the LMS and used for communication with the ONYX Editor.
324		-)))
325		-|(((
326		-property
327		-)))|(((
328		-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.
329		-)))
330		-|(((
331		-values
332		-)))|(((
333		-List of values to filter by, for example, list of user names.
334		-)))
335		-|(((
336		-reason
337		-)))|(((
338		-Reason for deletion. Will be included in the deletion log.
339		-)))
340		-|(((
341		-params
342		-)))|(((
343		-Currently not used
344		-)))
345		-
346		-=== returnValue deleteUser ===
347		-
348		-Deletion result information.
349		-
350		-|(((
351		-Key
352		-)))|(((
353		-The values as specified in the _values_ parameter
354		-)))
355		-|(((
356		-Value
357		-)))|(((
358		-Deletion result (e. g _NOT FOUND_, _ERROR:xyz_, ...)
359		-)))
360		-{{/layout-cell}}
361		-{{/layout-section}}
362		-{{/layout}}