Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zuletzt geändert von Carina Enke am 13.02.2024

Von 395.1 nach 396.1 Von 398.1 nach 399.1

Von Version 396.1

bearbeitet von Carina Enke
am 13.02.2024

Änderungskommentar: Es gibt keinen Kommentar für diese Version

Auf Version 398.1

bearbeitet von Carina Enke
am 13.02.2024

Änderungskommentar: Es gibt keinen Kommentar für diese Version

Rohform
Im Layout

Zusammenfassung

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

Details

Seiteneigenschaften

Inhalt

@@ -7,6 +7,10 @@
  {{layout-cell}}
  {{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
  {{toc start="2"/}}
++
++ **Weitere Informationen:**
++
++* [[Schnittstelle ONYX Player>>doc:ONYX.Systeminformationen.Schnittstelle ONYX Player.WebHome]]
  {{/panel}}
  {{/layout-cell}}
  {{/layout-section}}
@@ -361,346 +361,3 @@
  {{/layout-cell}}
  {{/layout-section}}
  {{/layout}}
--
--{{layout}}
--{{layout-section ac:type="two_equal"}}
--{{layout-cell}}
--====== Content: ======
--
--{{toc start="2"/}}
--{{/layout-cell}}
--
--{{layout-cell}}
--
--{{/layout-cell}}
--{{/layout-section}}
--
--{{layout-section ac:type="single"}}
--{{layout-cell}}
--== General information ==
--
--The API to the ONYX WebReporter enables the communication between the LMS and the Reporter. Therefore, a couple of commands will be executed:
--
--|(((
--armSite
--)))|(((
--Registration of sequence requests at the ONYX Reporter
--)))
--|(((
--initiateSite
--)))|(((
--Initiates the Reporter session (transmission of the CP).
--)))
--|(((
--disarmSite
--)))|(((
--Release of all Reporter resources for this session.
--)))
--|(((
--getResultValues
--)))|(((
--Returns all (requested) results for the test. Condition: There is only one student in the list transmitted with initiateSite.
--)))
--|(% colspan="1" %)(% colspan="1" %)
--(((
--getResultVariables
--)))|(% colspan="1" %)(% colspan="1" %)
--(((
--Returns all (requested) outcome variables for the test. No armSite, initiateSite, or disarmSite is required.
--)))
--
--== Login through the LMS ==
--
--{{code language="xml" title="Login through the LMS"}}
--@WebMethod(operationName = „armSite")
--public String armSite(
--@WebParam(name = „version") final Integer version,
--@WebParam(name = „userId") final String userId,
--@WebParam(name = „optionalRole") final Integer role,
--@WebParam(name = „secretToShare") final String secretToShare,
--@WebParam(name = „optionalUserLastName") final String userLastName,
--@WebParam(name = „optionalUserFirstName") final String userFirstName,
--@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
--}
--{{/code}}
--
--=== Parameter armSite ===
--
--|(((
--version
--)))|(((
--Requested version: 1
--)))
--|(((
--userId
--)))|(((
--UserId of the requested Reporter user
--)))
--|(((
--optionalRole
--)))|(((
--Optional. User role. 0 = student, 1 = tutor
--)))
--|(((
--secretToShare
--)))|(((
--A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
--)))
--|(((
--optionalUserLastName
--)))|(((
--Optional. Last name of the user.
--)))
--|(% colspan="1" %)(% colspan="1" %)
--(((
--optionalUserFirstName
--)))|(% colspan="1" %)(% colspan="1" %)
--(((
--Optional. First name of the user.
--)))
--|(% colspan="1" %)(% colspan="1" %)
--(((
--additionalParams
--)))|(% colspan="1" %)(% colspan="1" %)
--(((
--Reserved for future use.
--)))
--
--=== ReturnValue armSite ===
--
--|(((
--String
--)))|(((
--Session ID which has to be used to mark any other Reporter call.
--)))
--
--== Initialisation through LMS ==
--
--{{code language="xml" title="Initialisation through LMS"}}
--@WebMethod(operationName = „initiateSite")
--public String initiateSite(
--@WebParam(name = „version") final Integer version,
--@WebParam(name = „sessionId") final String sessionId,
--@WebParam(name = „secretToShare") final String secretToShare,
--@WebParam(name = „students") final ArrayList<ResultsForStudent> students,
--@WebParam(name = „optionalContentPackage") final byte[] contentPackage,
--@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
--}
--{{/code}}
--
--=== Parameter initiateSite ===
--
--|(((
--version
--)))|(((
--Requested version: 1
--)))
--|(% colspan="1" %)(% colspan="1" %)
--(((
--sessionId
--)))|(% colspan="1" %)(% colspan="1" %)
--(((
--SessionId, as returned by armSite.
--)))
--|(((
--secretToShare
--)))|(((
--A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
--)))
--|(((
--students
--)))|(((
--List of students and their results. See below.
--)))
--|(((
--optionalContentPackage
--)))|(((
--Optional. Content package (zipped) as byte array.
--)))
--|(((
--additionalParams
--)))|(((
--Reserved for future use.
--)))
--
--=== ReturnValue initiateSite ===
--
--|(((
--String
--)))|(((
--Absolute URL of the Reporter site for the IFrame. The URL has to be amended by the LMS with the following URL parameters:
--
--* sid: Session ID, as returned by armSite
--* (((
--uid: Student ID, as registrated in the initiateSite at the ONYX Reporter
--)))
--)))
--
--{{code language="xml"}}
--public class ResultsForStudent {
--   private String studentId = „";
--   private String firstname = „";
--   private String lastname = „";
--   private String groupname = „";
--   private String tutorname = „";
--   private File contentFile = null;
--   private byte[] resultsFile = null;
--}
--{{/code}}
--
--== Logout through the LMS ==
--
--
--{{code}}
--@WebMethod(operationName = „disarmSite")
--public Boolean disarmSite(
--@WebParam(name = „version") final Integer version,
--@WebParam(name = „sessionId") final String sessionId,
--@WebParam(name = „secretToShare") final String secretToShare,
--@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
--}
--{{/code}}
--
--
--=== Parameter disarmSite ===
--
--|(((
--version
--)))|(((
--Requested version: 1
--)))
--|(% colspan="1" %)(% colspan="1" %)
--(((
--sessionId
--)))|(% colspan="1" %)(% colspan="1" %)
--(((
--SessionId, as returned by armSite.
--)))
--|(((
--secretToShare
--)))|(((
--A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
--)))
--|(((
--additionalParams
--)))|(((
--Reserved for future use.
--)))
--
--=== ReturnValue disarmSite ===
--
--|(((
--Boolean
--)))|(((
--True in the case of success, otherwise false.
--)))
--
--== Request of learner results through the LMS ==
--
--{{code language="xml" title="Request of learner results through the LMS"}}
-- @WebMethod(operationName = „getResultValues")
--public HashMapWrapper getResultValues(
--   @WebParam(name = „version") final Integer version,
--   @WebParam(name = „sessionId") final String sessionId,
--   @WebParam(name = „secretToShare") final String secretToShare,
--   @WebParam(name = „requestedValues") final HashMap<String, String>
--        requestedValues,
--   @WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
--}
--{{/code}}
--
--=== Parameter getResultValues ===
--
--|(((
--version
--)))|(((
--Requested version: 1
--)))
--|(% colspan="1" %)(% colspan="1" %)
--(((
--sessionId
--)))|(% colspan="1" %)(% colspan="1" %)
--(((
--SessionId, as returned by armSite.
--)))
--|(((
--secretToShare
--)))|(((
--A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
--)))
--|(((
--requestedValues
--)))|(((
--Can be empty, in which case all result variables are returned. If keys are included, only the keys will be returned.
--)))
--|(((
--additionalParams
--)))|(((
--Reserved for future use.
--)))
--
--=== ReturnValue getResultValues ===
--
--|(((
--HashMap<String, String>
--)))|(((
--Map of result variables, key is the variable name, value is the respective variable's value (HashMap is wrapped)
--)))
--
--== Request of result variables through the LMS ==
--
--{{code language="xml" title="Request of result variables through the LMS"}}
-- @WebMethod(operationName = „getResultVariables")
--public HashMapWrapper getResultVariables(
--@WebParam(name = „version") final Integer version,
--@WebParam(name = „contentPackage") final byte[] contentPackage,
--@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
--}
--{{/code}}
--
--=== Parameter getResultVariables ===
--
--|(((
--version
--)))|(((
--Requested version: 1
--)))
--|(((
--contentPackage
--)))|(((
--Content package (zipped) as byte array.
--)))
--|(((
--additionalParams
--)))|(((
--Reserved for future use.
--)))
--
--=== ReturnValue getResultVariables ===
--
--|(((
--HashMap<String, String>
--)))|(((
--Map of result variables, key is the variable name, value is the respective variable's value (HashMap is wrapped)
--)))
--
--== Wrapper ==
--
--Since the transmission of maps and lists via JAX-WS can cause problems, they have to be wrapped.
--
--=== Wrapper for HashMap<String, String> ===
--
--HashMapWrapper.java:
--
--[[image:attach:HashMapWrapperjava.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
--
--[[image:attach:HashMapWrapperjava2.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
--
--=== Wrapper for the ArrayList<ResultsForStudent> ===
--
--ResultsForStudentsWrapper.java:
--
--[[image:attach:ResultsForStudentsWrapperjava.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
--{{/layout-cell}}
--{{/layout-section}}
--{{/layout}}

Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zusammenfassung

Details

Suchen

ONYXGlobal

ONYXMenü

Zuletzt besucht