Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zusammenfassung

• Seiteneigenschaften (1 geändert, 0 hinzugefügt, 0 gelöscht)
• Objekte (1 geändert, 0 hinzugefügt, 0 gelöscht)
  • Confluence.Code.ConfluencePageClass[0]

Details

Seiteneigenschaften

Inhalt

...	...	@@ -386,29 +386,29 @@
386	386
387	387	{{layout-section ac:type="single"}}
388	388	{{layout-cell}}
389		-== General ==
	389	+== General information ==
390	390
391		-The API to the ONYX WebReporter enables the communication between the LMS and the reporter. Therefore, a couple of commands will be executed:
	391	+The API to the ONYX WebReporter enables the communication between the LMS and the Reporter. Therefore, a couple of commands will be executed:
392	392
393	393	|(((
394	394	armSite
395	395	)))|(((
396		-Registration of sequence requests at the ONYX reporter
	396	+Registration of sequence requests at the ONYX Reporter
397	397	)))
398	398	|(((
399	399	initiateSite
400	400	)))|(((
401		-Initiates the reporter session (transmission of the CP).
	401	+Initiates the Reporter session (transmission of the CP).
402	402	)))
403	403	|(((
404	404	disarmSite
405	405	)))|(((
406		-Release of all reporter resources for this session.
	406	+Release of all Reporter resources for this session.
407	407	)))
408	408	|(((
409	409	getResultValues
410	410	)))|(((
411		-Returns all or all requested results for the test. Condition: there is exactly one student in list transmitted in the initiateSite.
	411	+Returns all (requested) results for the test. Condition: There is only one student in the list transmitted with initiateSite.
412	412	)))
413	413	|(% colspan="1" %)(% colspan="1" %)
414	414	(((
...	...	@@ -415,12 +415,12 @@
415	415	getResultVariables
416	416	)))|(% colspan="1" %)(% colspan="1" %)
417	417	(((
418		-Returns all or all requested outcome variables for the test. No armSite, initiateSite or disarmSite is necessary.
	418	+Returns all (requested) outcome variables for the test. No armSite, initiateSite, or disarmSite is required.
419	419	)))
420	420
421		-== Connection to the LMS ==
	421	+== Login through the LMS ==
422	422
423		-{{code language="xml" title="Anmeldung des LMS"}}
	423	+{{code language="xml" title="Login through the LMS"}}
424	424	@WebMethod(operationName = „armSite")
425	425	public String armSite(
426	426	@WebParam(name = „version") final Integer version,
...	...	@@ -443,22 +443,22 @@
443	443	|(((
444	444	userId
445	445	)))|(((
446		-UserId of the requested reporter user
	446	+UserId of the requested Reporter user
447	447	)))
448	448	|(((
449	449	optionalRole
450	450	)))|(((
451		-Optional. User role. 0=student, 1=tutor
	451	+Optional. User role. 0 = student, 1 = tutor
452	452	)))
453	453	|(((
454	454	secretToShare
455	455	)))|(((
456		-Shared secret. Has to remain identical for every communication.
	456	+A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
457	457	)))
458	458	|(((
459	459	optionalUserLastName
460	460	)))|(((
461		-Optional. User lastname.
	461	+Optional. Last name of the user.
462	462	)))
463	463	|(% colspan="1" %)(% colspan="1" %)
464	464	(((
...	...	@@ -465,7 +465,7 @@
465	465	optionalUserFirstName
466	466	)))|(% colspan="1" %)(% colspan="1" %)
467	467	(((
468		-Optional. User firstname.
	468	+Optional. First name of the user.
469	469	)))
470	470	|(% colspan="1" %)(% colspan="1" %)
471	471	(((
...	...	@@ -480,12 +480,12 @@
480	480	|(((
481	481	String
482	482	)))|(((
483		-Session ID that has to be used to mark any further reporter call.
	483	+Session ID which has to be used to mark any other Reporter call.
484	484	)))
485	485
486	486	== Initialisation through LMS ==
487	487
488		-{{code language="xml" title="Initialisierung durch LMS"}}
	488	+{{code language="xml" title="Initialisation through LMS"}}
489	489	@WebMethod(operationName = „initiateSite")
490	490	public String initiateSite(
491	491	@WebParam(name = „version") final Integer version,
...	...	@@ -514,17 +514,17 @@
514	514	|(((
515	515	secretToShare
516	516	)))|(((
517		-Shared secret. Has to remain identical at every communication.
	517	+A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
518	518	)))
519	519	|(((
520	520	students
521	521	)))|(((
522		-List of students with their results. See below.
	522	+List of students and their results. See below.
523	523	)))
524	524	|(((
525	525	optionalContentPackage
526	526	)))|(((
527		-Optional. Content Package (zipped) as byte array.
	527	+Optional. Content package (zipped) as byte array.
528	528	)))
529	529	|(((
530	530	additionalParams
...	...	@@ -537,11 +537,11 @@
537	537	|(((
538	538	String
539	539	)))|(((
540		-Absolute URL of the reporter site for the frame. It has to be enriched by the LMS with the following URLparameters:
	540	+Absolute URL of the Reporter site for the IFrame. The URL has to be amended by the LMS with the following URL parameters:
541	541
542		-* sid: Session ID as returned by armSite
	542	+* sid: Session ID, as returned by armSite
543	543	* (((
544		-uid: Student ID as registrated in the initiateSite at the ONYX Reporter.
	544	+uid: Student ID, as registrated in the initiateSite at the ONYX Reporter
545	545	)))
546	546	)))
547	547
...	...	@@ -557,7 +557,7 @@
557	557	}
558	558	{{/code}}
559	559
560		-== Deconnection through the LMS ==
	560	+== Logout through the LMS ==
561	561
562	562
563	563
...	...	@@ -590,7 +590,7 @@
590	590	|(((
591	591	secretToShare
592	592	)))|(((
593		-Shared secret. Has to remain identical at every communication.
	593	+A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
594	594	)))
595	595	|(((
596	596	additionalParams
...	...	@@ -603,12 +603,12 @@
603	603	|(((
604	604	Boolean
605	605	)))|(((
606		-True if successful, otherwise false.
	606	+True in the case of success, otherwise false.
607	607	)))
608	608
609		-== Request of learning results through the LMS ==
	609	+== Request of learner results through the LMS ==
610	610
611		-{{code language="xml" title="Abfrage von Lernerresultaten durch LMS"}}
	611	+{{code language="xml" title="Request of learner results through the LMS"}}
612	612	@WebMethod(operationName = „getResultValues")
613	613	public HashMapWrapper getResultValues(
614	614	@WebParam(name = „version") final Integer version,
...	...	@@ -637,12 +637,12 @@
637	637	|(((
638	638	secretToShare
639	639	)))|(((
640		-Shared secret. Has to remain identical at every communication.
	640	+A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
641	641	)))
642	642	|(((
643	643	requestedValues
644	644	)))|(((
645		-Can be empty, thus all result variables will be returned. If it contains keys, only those will be returned.
	645	+Can be empty, in which case all result variables are returned. If keys are included, only the keys will be returned.
646	646	)))
647	647	|(((
648	648	additionalParams
...	...	@@ -655,12 +655,12 @@
655	655	|(((
656	656	HashMap<String, String>
657	657	)))|(((
658		-Map of result variables, key is the variable name, value the corresponding value (HashMap is wrapped)
	658	+Map of result variables, key is the variable name, value is the respective variable's value (HashMap is wrapped)
659	659	)))
660	660
661	661	== Request of result variables through the LMS ==
662	662
663		-{{code language="xml" title="Abfrage von Ergebnisvariablen durch LMS"}}
	663	+{{code language="xml" title="Request of result variables through the LMS"}}
664	664	@WebMethod(operationName = „getResultVariables")
665	665	public HashMapWrapper getResultVariables(
666	666	@WebParam(name = „version") final Integer version,
...	...	@@ -692,13 +692,12 @@
692	692	|(((
693	693	HashMap<String, String>
694	694	)))|(((
695		-Map of result variables, key is the variable name, value the corresponding
696		-value (HashMap is wrapped).
	695	+Map of result variables, key is the variable name, value is the respective variable's value (HashMap is wrapped)
697	697	)))
698	698
699	699	== Wrapper ==
700	700
701		-As the transmission of maps and lists generate problems via JAX-WS (lists filled by the customer are sent without any data and thus reach the server without data) they have to be wrapped.
	700	+Since the transmission of maps and lists via JAX-WS can cause problems, they have to be wrapped.
702	702
703	703	=== Wrapper for HashMap<String, String> ===
704	704

Confluence.Code.ConfluencePageClass[0]

id

...	...	@@ -1,1 +1,1 @@
1		-182190540
	1	+182518074

url

...	...	@@ -1,1 +1,1 @@
1		-https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/182190540/Schnittstelle ONYX Reporter
	1	+https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/182518074/Schnittstelle ONYX Reporter