Zum Inhalt springen

Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zuletzt geändert von Carina Enke am 13.02.2024
Von Version 375.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
... ... @@ -74,7 +74,8 @@
74 74  
75 75  == Anmeldung des LMS ==
76 76  
77 -{{code title="Anmeldung des LMS" language="xml"}}@WebMethod(operationName = „armSite")
77 +{{code title="Anmeldung des LMS" language="xml"}}
78 +@WebMethod(operationName = „armSite")
78 78  public String armSite(
79 79  @WebParam(name = „version") final Integer version,
80 80  @WebParam(name = „userId") final String userId,
... ... @@ -83,37 +83,142 @@
83 83  @WebParam(name = „optionalUserLastName") final String userLastName,
84 84  @WebParam(name = „optionalUserFirstName") final String userFirstName,
85 85  @WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
86 -}{{/code}}Parameter armSite
87 +}
88 +{{/code}}
87 87  
90 +=== Parameter armSite ===
91 +
88 88  |(((
89 -
93 +version
90 90  )))|(((
91 -
95 +Angefragte Version: 1
92 92  )))
93 93  |(((
94 -
98 +userId
95 95  )))|(((
96 -
100 +UserId des anfragenden Reporter-Benutzers
97 97  )))
98 98  |(((
99 -
103 +optionalRole
100 100  )))|(((
101 -
105 +Optional. Rolle des Benutzers. 0 = Student, 1= Tutor
102 102  )))
103 103  |(((
104 -
108 +secretToShare
105 105  )))|(((
106 -
110 +Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
107 107  )))
108 108  |(((
109 -
113 +optionalUserLastName
110 110  )))|(((
111 -
115 +Optional. Nachname des Benutzers.
112 112  )))
117 +|(% colspan="1" %)(% colspan="1" %)
118 +(((
119 +optionalUserFirstName
120 +)))|(% colspan="1" %)(% colspan="1" %)
121 +(((
122 +Optional. Vorname des Benutzers.
123 +)))
124 +|(% colspan="1" %)(% colspan="1" %)
125 +(((
126 +additionalParams
127 +)))|(% colspan="1" %)(% colspan="1" %)
128 +(((
129 +Reserved for future use.
130 +)))
113 113  
114 -= Überschrift2 =
132 +=== ReturnValue armSite ===
115 115  
116 -Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam fermentum vestibulum est. Cras rhoncus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Sed quis tortor. Donec non ipsum. Mauris condimentum, odio nec porta tristique, ante neque malesuada massa, in dignissim eros velit at tellus. Donec et risus in ligula eleifend consectetuer. Donec volutpat eleifend augue. Integer gravida sodales leo. Nunc vehicula neque ac erat. Vivamus non nisl. Fusce ac magna. Suspendisse euismod libero eget mauris.
134 +|(((
135 +String
136 +)))|(((
137 +Session ID, mit der alle weiteren Reporter-Aufrufe gekennzeichnet werden müssen.
138 +)))
139 +
140 +== Initialisierung durch LMS ==
141 +
142 +{{code title="Initialisierung durch LMS" language="xml"}}
143 +@WebMethod(operationName = „initiateSite")
144 +public String initiateSite(
145 +@WebParam(name = „version") final Integer version,
146 +@WebParam(name = „sessionId") final String sessionId,
147 +@WebParam(name = „secretToShare") final String secretToShare,
148 +@WebParam(name = „students") final ArrayList<ResultsForStudent> students,
149 +@WebParam(name = „optionalContentPackage") final byte[] contentPackage,
150 +@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
151 +}
152 +{{/code}}
153 +
154 +=== Parameter initiateSite ===
155 +
156 +|(((
157 +version
158 +)))|(((
159 +Angefragte Version: 1
160 +)))
161 +|(% colspan="1" %)(% colspan="1" %)
162 +(((
163 +sessionId
164 +)))|(% colspan="1" %)(% colspan="1" %)
165 +(((
166 +SessionId, wie von armSite zurück geliefert.
167 +)))
168 +|(((
169 +secretToShare
170 +)))|(((
171 +Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
172 +)))
173 +|(((
174 +students
175 +)))|(((
176 +Liste der Studenten mit ihren Resultaten. Siehe unten.
177 +)))
178 +|(((
179 +optionalContentPackage
180 +)))|(((
181 +Optional. Content Package (gezippt) als Byte-Array.
182 +)))
183 +|(((
184 +additionalParams
185 +)))|(((
186 +Reserved for future use.
187 +)))
188 +
189 +=== ReturnValue initiateSite ===
190 +
191 +|(((
192 +String
193 +)))|(((
194 +Absolute URL der Reporter-Seite für den IFrame. Dieser ist vom LMS durch die folgenden URL-Parameter anzureichern:
195 +
196 +* sid: Session ID, wie von armSite zurück gegeben
197 +* uid: Student ID, wie in initiateSite beim Reporter angemeldet
198 +)))
199 +
200 +{{code language="xml"}}
201 +public class ResultsForStudent {
202 +   private String studentId = „";
203 +   private String firstname = „";
204 +   private String lastname = „";
205 +   private String groupname = „";
206 +   private String tutorname = „";
207 +   private File contentFile = null;
208 +   private byte[] resultsFile = null;
209 +}
210 +{{/code}}
211 +
212 +{{code title="Initialisierung durch LMS" language="xml"}}
213 +@WebMethod(operationName = „initiateSite")
214 +public String initiateSite(
215 +@WebParam(name = „version") final Integer version,
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,
220 +@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
221 +}
222 +{{/code}}
117 117  {{/layout-cell}}
118 118  {{/layout-section}}
119 119  
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -3342392
1 +3342394
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342392/Schnittstelle ONYX Reporter
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342394/Schnittstelle ONYX Reporter