Änderungen von Dokument 07 Schnittstelle ONYX Player

Zuletzt geändert von Carina Enke am 26.11.2025

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

Zusammenfassung

Details

Seiteneigenschaften
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,29 +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  
11 -== General information ==
12 -
13 -The ONYX Player defines a web service which is accessible via the URL **<ONYXPlayer-URL>/onyx/onyxexamservices**.
14 -
15 -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"]]
16 -
17 -{{info}}
18 -WDSL will be replaced by a REST web service in the future. Simple documentation of the available endpoints and parameters is available at the URL <ONYXPlayer-URL>/onyx/rest/doc.
19 -{{/info}}
20 -
21 -All information on this page relates to the WDSL web service.
22 -{{/column}}
23 -
24 -{{column width="30%"}}
25 -{{panel title="Inhalt"}}
13 +{{layout-cell}}
14 +{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Content"}}
26 26  {{toc start="2"/}}
27 27  {{/panel}}
17 +{{/layout-cell}}
18 +{{/layout-section}}
28 28  
29 -{{/column}}
30 -{{/section}}
20 +{{layout-section ac:type="single"}}
21 +{{layout-cell}}
22 +== General information ==
31 31  
24 +The ONYX Player defines a web service, which is accessible via the URL **<ONYXPlayer-URL>/onyx/onyxexamservices**.
32 32  
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"]]
27 +
33 33  == Registration of a test ==
34 34  
35 35  Before participants can take tests, the tests need to be registered with ONYX.
... ... @@ -46,6 +46,7 @@
46 46  
47 47  === Parameters registerTest ===
48 48  
44 +(% class="wrapped" %)
49 49  |(((
50 50  testSessionId
51 51  )))|(((
... ... @@ -161,7 +161,7 @@
161 161  
162 162  Test evaluation:
163 163  
164 -
160 +(% class="wrapped" %)
165 165  |=(((
166 166  Parameter
167 167  )))|=(((
... ... @@ -198,7 +198,7 @@
198 198  
199 199  === ReturnValue registerTest ===
200 200  
201 -
197 +(% class="wrapped" %)
202 202  |(((
203 203  Long
204 204  )))|(((
... ... @@ -397,7 +397,17 @@
397 397  {{error title="Security"}}
398 398  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.
399 399  {{/error}}
396 +{{/layout-cell}}
397 +{{/layout-section}}
400 400  
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}}
401 401  {{column}}
402 402  (% class="auto-cursor-target" %)
403 403  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.
... ... @@ -411,4 +411,6 @@
411 411  You are also welcome to use our (% style="text-align:left" %)**[[Contact form>>url:https://www.bps-system.de/cms/kontakt/||shape="rect"]]**(%%).
412 412  {{/panel}}
413 413  {{/column}}
414 -
420 +{{/layout-cell}}
421 +{{/layout-section}}
422 +{{/layout}}