Änderungen von Dokument 07 Schnittstelle ONYX Player

Zuletzt geändert von Carina Enke am 26.11.2025

Von Version 370.1
bearbeitet von Carina Enke
am 02.05.2025
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 361.1
bearbeitet von Carina Enke
am 13.02.2024
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Titel
... ... @@ -1,1 +1,1 @@
1 -07 Schnittstelle ONYX Player
1 +09 Schnittstelle ONYX Player
Inhalt
... ... @@ -1,5 +1,6 @@
1 -{{section}}
2 -{{column width="60%"}}
1 +{{layout}}
2 +{{layout-section ac:type="two_right_sidebar"}}
3 +{{layout-cell}}
3 3  The API between the ONYX Player and the LMS consists of the following components:
4 4  
5 5  * Registration of a test with the ONYX Player through the LMS
... ... @@ -7,27 +7,23 @@
7 7  * Test control
8 8  * Return of test results to the LMS through the ONYX Player
9 9  * Deregistration of the test
11 +{{/layout-cell}}
10 10  
13 +{{layout-cell}}
14 +{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Content"}}
15 +{{toc start="2"/}}
16 +{{/panel}}
17 +{{/layout-cell}}
18 +{{/layout-section}}
11 11  
12 -
20 +{{layout-section ac:type="single"}}
21 +{{layout-cell}}
13 13  == General information ==
14 14  
15 -The ONYX Player defines a web service which is accessible via the URL **<ONYXPlayer-URL>/onyx/onyxexamservices**. Link to the WSDL of the public demo runtime: [[http:~~/~~/demo.bps-system.de/onyx/onyxexamservices?wsdl>>url:http://demo.bps-system.de/onyx/||shape="rect"]]
24 +The ONYX Player defines a web service, which is accessible via the URL **<ONYXPlayer-URL>/onyx/onyxexamservices**.
16 16  
17 -{{info}}
18 -WDSL will be replaced by a REST web service in the future. Initial documentation of the available endpoints and parameters is available at the URL **<ONYXPlayer-URL>/onyx/rest/doc**.
19 -{{/info}}
26 +Link to the WSDL of the public demo runtime: [[http:~~/~~/demo.bps-system.de/onyx/onyxexamservices?wsdl>>url:http://demo.bps-system.de/onyx/||shape="rect"]]
20 20  
21 -All information on this page relates to the WDSL web service.
22 -{{/column}}
23 -
24 -{{column width="30%"}}
25 -{{panel title="Inhalt"}}
26 -{{toc start="2" depth="2"/}}
27 -{{/panel}}
28 -{{/column}}
29 -{{/section}}
30 -
31 31  == Registration of a test ==
32 32  
33 33  Before participants can take tests, the tests need to be registered with ONYX.
... ... @@ -44,6 +44,7 @@
44 44  
45 45  === Parameters registerTest ===
46 46  
44 +(% class="wrapped" %)
47 47  |(((
48 48  testSessionId
49 49  )))|(((
... ... @@ -159,7 +159,7 @@
159 159  
160 160  Test evaluation:
161 161  
162 -
160 +(% class="wrapped" %)
163 163  |=(((
164 164  Parameter
165 165  )))|=(((
... ... @@ -196,7 +196,7 @@
196 196  
197 197  === ReturnValue registerTest ===
198 198  
199 -
197 +(% class="wrapped" %)
200 200  |(((
201 201  Long
202 202  )))|(((
... ... @@ -395,7 +395,17 @@
395 395  {{error title="Security"}}
396 396  Both the WSDL of the ONYX Player and the LMS should not be accessible/visible "from the outside". This also applies to the respective web services. The web GUI of the LMS and the ONYX Player, in contrast, must be visible to and accessible by all users. If HTTPS is used during the test process (which is strongly recommended), then the appropriate certificate must be known to the corresponding JVM of the LMS and the ONYX Player. Otherwise web service communication will not be possible.
397 397  {{/error}}
396 +{{/layout-cell}}
397 +{{/layout-section}}
398 398  
399 +{{layout-section ac:type="single"}}
400 +{{layout-cell}}
401 +----
402 +{{/layout-cell}}
403 +{{/layout-section}}
404 +
405 +{{layout-section ac:type="single"}}
406 +{{layout-cell}}
399 399  {{column}}
400 400  (% class="auto-cursor-target" %)
401 401  If you have any questions about the configuration or the use of the ONYX Testsuite in other platforms, we will be happy to help you.
... ... @@ -409,3 +409,6 @@
409 409  You are also welcome to use our (% style="text-align:left" %)**[[Contact form>>url:https://www.bps-system.de/cms/kontakt/||shape="rect"]]**(%%).
410 410  {{/panel}}
411 411  {{/column}}
420 +{{/layout-cell}}
421 +{{/layout-section}}
422 +{{/layout}}