Ä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	+Schnittstelle ONYX Editor

Inhalt

...	...	@@ -1,13 +1,24 @@
	1	+
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	+
8	8	{{panel title="Inhalt"}}
9		-{{toc depth="3" start="2"/}}
	17	+
	18	+
	19	+{{toc/}}
10	10	{{/panel}}
	21	+
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.
...	...	@@ -183,16 +183,22 @@
183	183	{{/layout-section}}
184	184	{{/layout}}
185	185
	211	+
	212	+
186	186	{{layout}}
187	187	{{layout-section ac:type="two_right_sidebar"}}
188	188	{{layout-cell}}
189		-
	216	+\\
190	190	{{/layout-cell}}
191	191
192	192	{{layout-cell}}
	220	+
193	193	{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Content"}}
194		-{{toc start="2"/}}
	222	+
	223	+
	224	+{{toc/}}
195	195	{{/panel}}
	226	+
196	196	{{/layout-cell}}
197	197	{{/layout-section}}
198	198
...	...	@@ -210,6 +210,7 @@
210	210	@RestParam(name = "params") final Map<String, String> params) {}
211	211	{{/code}}
212	212
	244	+\\
213	213
214	214	=== Parameter saveResult2 ===
215	215
...	...	@@ -229,6 +229,8 @@
229	229	Generic parameters. These are currently only stored without further processing.
230	230	)))
231	231
	264	+\\
	265	+
232	232	=== returnValue saveResult2 ===
233	233
234	234	|(((
...	...	@@ -239,6 +239,8 @@
239	239
240	240	== Save results (legacy) ==
241	241
	276	+\\
	277	+
242	242	{{code title="Save results (legacy)"}}
243	243	@RestMethod(name = "saveResult")
244	244	public Boolean saveResult(
...	...	@@ -246,6 +246,7 @@
246	246	@RestParam(name = "resultFile") final byte[] resultFile) {}
247	247	{{/code}}
248	248
	285	+\\
249	249
250	250	=== Parameter saveResult2 ===
251	251
...	...	@@ -268,18 +268,24 @@
268	268	True if successful, otherwise false
269	269	)))
270	270
	308	+\\
	309	+
271	271	== Query interface version ==
272	272
	312	+\\
	313	+
273	273	{{code title="Query version"}}
274	274	@RestMethod(name = "version")
275	275	public String version() {}
276	276	{{/code}}
277	277
	319	+\\
278	278
279	279	=== Parameter version ===
280	280
281	281	None
282	282
	325	+\\
283	283
284	284	=== returnValue saveResult2 ===
285	285
...	...	@@ -289,6 +289,8 @@
289	289	REST interface version, currently always "1.0 (ONYX Editor version)"
290	290	)))
291	291
	335	+\\
	336	+
292	292	== Delete user ==
293	293
294	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.
...	...	@@ -360,3 +360,4 @@
360	360	{{/layout-cell}}
361	361	{{/layout-section}}
362	362	{{/layout}}
	408	+