Zum Inhalt springen

Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zuletzt geändert von Carina Enke am 13.02.2024
Von Version 373.1
bearbeitet von tleu
am 01.12.2014
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 377.1
bearbeitet von tleu
am 01.12.2014
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -60,7 +60,9 @@
60 60  |(((
61 61  getResultValues
62 62  )))|(((
63 -Gibt alle bzw. die angeforderten Resultate für den Test zurück. Voraussetzung: Es ist nur exakt ein Student in der bei initiateSite übertragenen Liste.
63 +Gibt alle bzw. die angeforderten Resultate für den Test zurück. Voraussetzung:
64 +
65 +Es ist nur exakt ein Student in der bei initiateSite übertragenen Liste.
64 64  )))
65 65  |(% colspan="1" %)(% colspan="1" %)
66 66  (((
... ... @@ -207,151 +207,17 @@
207 207  }
208 208  {{/code}}
209 209  
210 -== Abmeldung durch LMS ==
211 -
212 -Abfrage von Lernerresultaten durch LMS
213 -
214 -
215 -
216 -|(((
217 -version
218 -)))|(((
219 -Angefragte Version: 1
220 -)))
221 -|(% colspan="1" %)(% colspan="1" %)
222 -(((
223 -sessionId
224 -)))|(% colspan="1" %)(% colspan="1" %)
225 -(((
226 -SessionId, wie von armSite zurück geliefert.
227 -)))
228 -|(((
229 -secretToShare
230 -)))|(((
231 -Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
232 -)))
233 -|(((
234 -additionalParams
235 -)))|(((
236 -Reserved for future use.
237 -)))
238 -
239 -=== ReturnValue disarmSite ===
240 -
241 -|(((
242 -Boolean
243 -)))|(((
244 -True bei Erfolg, sonst false.
245 -)))
246 -
247 -== Abfrage von Lernerresultaten durch LMS ==
248 -
249 -{{code title="Abfrage von Lernerresultaten durch LMS" language="xml"}}
250 - @WebMethod(operationName = „getResultValues")
251 -public HashMapWrapper getResultValues(
252 - @WebParam(name = „version") final Integer version,
253 - @WebParam(name = „sessionId") final String sessionId,
254 - @WebParam(name = „secretToShare") final String secretToShare,
255 - @WebParam(name = „requestedValues") final HashMap<String, String>
256 - requestedValues,
257 - @WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
258 -}
259 -{{/code}}
260 -
261 -=== Parameter getResultValues ===
262 -
263 -|(((
264 -version
265 -)))|(((
266 -Angefragte Version: 1
267 -)))
268 -|(% colspan="1" %)(% colspan="1" %)
269 -(((
270 -sessionId
271 -)))|(% colspan="1" %)(% colspan="1" %)
272 -(((
273 -SessionId, wie von armSite zurück geliefert.
274 -)))
275 -|(((
276 -secretToShare
277 -)))|(((
278 -Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
279 -)))
280 -|(((
281 -requestedValues
282 -)))|(((
283 -Kann leer sein, dann werden alle Result-Variables zurück geliefert. Sind Keys enthalten, so kommen nur diese zurück.
284 -)))
285 -|(((
286 -additionalParams
287 -)))|(((
288 -Reserved for future use.
289 -)))
290 -
291 -=== ReturnValue getResultValues ===
292 -
293 -|(((
294 -HashMap<String, String>
295 -)))|(((
296 -Map der Result-Variables, Key ist der Variablenname, Value der jeweilige Wert (HashMap ist gewrappt)
297 -)))
298 -
299 -== Abfrage von Ergebnisvariablen durch LMS ==
300 -
301 -{{code title="Abfrage von Ergebnisvariablen durch LMS" language="xml"}}
302 - @WebMethod(operationName = „getResultVariables")
303 -public HashMapWrapper getResultVariables(
212 +{{code title="Initialisierung durch LMS" language="xml"}}
213 +@WebMethod(operationName = „initiateSite")
214 +public String initiateSite(
304 304  @WebParam(name = „version") final Integer version,
305 -@WebParam(name = „contentPackage") final byte[] contentPackage,
216 +@WebParam(name = „sessionId") final String sessionId,
217 +@WebParam(name = „secretToShare") final String secretToShare,
218 +@WebParam(name = „students") final ArrayList<ResultsForStudent> students,
219 +@WebParam(name = „optionalContentPackage") final byte[] contentPackage,
306 306  @WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
307 307  }
308 308  {{/code}}
309 -
310 -=== Parameter getResultVariables ===
311 -
312 -|(((
313 -version
314 -)))|(((
315 -Angefragte Version: 1
316 -)))
317 -|(((
318 -contentPackage
319 -)))|(((
320 -Content Package (gezippt) als Byte-Array.
321 -)))
322 -|(((
323 -additionalParams
324 -)))|(((
325 -Reserved for future use.
326 -)))
327 -
328 -=== ReturnValue getResultVariables ===
329 -
330 -|(((
331 -HashMap<String, String>
332 -)))|(((
333 -Map der Result-Variables, Key ist der Variablenname, Value der jeweilige Wert (HashMap ist gewrappt)
334 -)))
335 -
336 -== Wrapper ==
337 -
338 -Da die Übertragung von Maps und Listen über JAX-WS Probleme macht (clientseitig gefüllte Listen werden leer über den WS versandt und kommen daher auch leer serverseitig an), müssen diese gewrappt werden.
339 -
340 -=== Wrapper für die HashMap<String, String> ===
341 -
342 -HashMapWrapper.java:
343 -
344 -[[image:attach:HashMapWrapperjava.png]]
345 -
346 -[[image:attach:HashMapWrapperjava2.png]]
347 -
348 -
349 -
350 -
351 -
352 -Wrapper für die ArrayList<ResultsForStudent>
353 -
354 -[[image:attach:ResultsForStudentsWrapperjava.png]]
355 355  {{/layout-cell}}
356 356  {{/layout-section}}
357 357  
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -3342397
1 +3342394
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342397/Schnittstelle ONYX Reporter
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342394/Schnittstelle ONYX Reporter