Zum Inhalt springen

Wiki-Quellcode von Schnittstelle ONYX Editor

Version 78.1 von Carina Enke am 08.05.2019
Zeige letzte Bearbeiter
1 {{sv-translation language="de"}}
2 {{layout}}
3 {{layout-section ac:type="single"}}
4 {{layout-cell}}{{/layout-cell}}
5 {{/layout-section}}
6
7 {{layout-section ac:type="two_right_sidebar"}}
8 {{layout-cell}}
9
10 {{/layout-cell}}
11
12 {{layout-cell}}
13 {{scroll-ignore}}
14 {{panel title="Inhalt"}}
15
16
17 {{toc/}}
18 {{/panel}}
19 {{/scroll-ignore}}
20
21
22
23
24 {{/layout-cell}}
25 {{/layout-section}}
26
27 {{layout-section ac:type="single"}}
28 {{layout-cell}}
29 == Ergebnisse speichern ==
30
31 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:
32
33 {{code title="Ergebnisse speichern"}}
34 @RestMethod(name = "saveResult2")
35 public Boolean saveResult(
36 @RestParam(name = "uniqueId") final String uniqueId,
37 @RestParam(name = "resultFile") final byte[] resultFile,
38 @RestParam(name = "params") final Map<String, String> params) {}
39 {{/code}}
40
41
42
43 === Parameter saveResult2 ===
44
45 |(((
46 uniqueId
47 )))|(((
48 Eindeutige ID, die ONYX WebPlayer und ONYX Editor bei der Ausführung des Tests vereinbart haben
49 )))
50 |(((
51 resultFile
52 )))|(((
53 Ergebnis-Datei als ZIP-File (QTI-konformes result.xml, ggf. inkl. darin referenzierter Dateien wie User-Uploads oder User-Contents
54 )))
55 |(((
56 params
57 )))|(((
58 Generische Parameter. Diese werden aktuell ohne weitere Verarbeitung einfach nur gespeichert.
59 )))
60
61
62
63 === returnValue saveResult2 ===
64
65 |(((
66 boolean
67 )))|(((
68 True bei Erfolg, sonst false
69 )))
70
71 == Ergebnisse speichern (Legacy) ==
72
73
74
75 {{code title="Ergebnisse speichern (Legacy)"}}
76 @RestMethod(name = "saveResult")
77 public Boolean saveResult(
78 @RestParam(name = "uniqueId") final String uniqueId,
79 @RestParam(name = "resultFile") final byte[] resultFile) {}
80 {{/code}}
81
82
83
84 === Parameter saveResult2 ===
85
86 |(((
87 uniqueId
88 )))|(((
89 Eindeutige ID, die ONYX WebPlayer und ONYX Editor bei der Ausführung des Tests vereinbart haben
90 )))
91 |(((
92 resultFile
93 )))|(((
94 Ergebnis-Datei als ZIP-File (QTI-konformes result.xml, ggf. inkl. darin referenzierter Dateien wie User-Uploads oder User-Contents
95 )))
96
97 === returnValue saveResult2 ===
98
99 |(((
100 boolean
101 )))|(((
102 True bei Erfolg, sonst false
103 )))
104
105
106
107 == Version der Schnittstelle abfragen ==
108
109
110
111 {{code title="Version abfragen"}}
112 @RestMethod(name = "version")
113 public String version() {}
114 {{/code}}
115
116
117
118 === Parameter version ===
119
120 keine
121
122
123
124 === returnValue saveResult2 ===
125
126 |(((
127 String
128 )))|(((
129 Version der REST-Schnittstelle, aktuell immer "1.0 (ONYX-Editor-Version)"
130 )))
131
132
133
134 == Nutzer löschen ==
135
136 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.
137
138 {{code title="Nutzer löschen"}}
139 @RestMethod
140 public Map<String, String> deleteUser(
141 @RestParam(name = "login") final String login,
142 @RestParam(name = "password") final String password,
143 @RestParam(name = "repo") final String repo,
144 @RestParam(name = "property") final String property,
145 @RestParam(name = "values") final ArrayList<String> values,
146 @RestParam(name = "reason") final String reason,
147 @RestParam(name = "params") final Map<String, String> params) {}
148 {{/code}}
149
150 === Parameter deleteUser ===
151
152 |(((
153 login
154 )))|(((
155 Username eines ONYX-Editor-Admin-Nutzers, der das Recht hat, andere Nutzer zu löschen.
156 )))
157 |(((
158 password
159 )))|(((
160 Passwort dieses ONYX-Editor-Admin-Nutzers.
161 )))
162 |(((
163 repo
164 )))|(((
165 ID des LMS-Repositories, so wie diese im LMS bereits konfiguriert ist und zur Kommunikation mit dem ONYX Editor verwendet wird
166 )))
167 |(((
168 property
169 )))|(((
170 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.
171 )))
172 |(((
173 values
174 )))|(((
175 Liste der Werte, nach denen gefiltert wird, bspw. Liste der Nutzernamen.
176 )))
177 |(((
178 reason
179 )))|(((
180 Lösch-Grund. Wird mit ins Lösch-Log geschrieben.
181 )))
182 |(((
183 params
184 )))|(((
185 Aktuell nicht genutzt
186 )))
187
188 === returnValue deleteUser ===
189
190 Löschresultat-Informationen.
191
192 |(((
193 Key
194 )))|(((
195 Die Values, wie im Parameter _values_ angegeben
196 )))
197 |(((
198 Value
199 )))|(((
200 Löschresultat (bspw. _NOT FOUND_, _ERROR:xyz_, ...)
201 )))
202 {{/layout-cell}}
203 {{/layout-section}}
204 {{/layout}}
205 {{/sv-translation}}
206
207 {{sv-translation language="en"}}
208 {{layout}}
209 {{layout-section ac:type="two_right_sidebar"}}
210 {{layout-cell}}
211
212 {{/layout-cell}}
213
214 {{layout-cell}}
215 {{scroll-ignore}}
216 {{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="On this page"}}
217
218
219 {{toc/}}
220
221 **related pages**
222
223 * pages
224 {{/panel}}
225 {{/scroll-ignore}}
226 {{/layout-cell}}
227 {{/layout-section}}
228 {{/layout}}
229 {{/sv-translation}}