Wiki-Quellcode von Schnittstelle ONYX Editor

Version 89.1 von Carina Enke am 08.05.2019

version	line-number	content
30.1	1	{{layout}}
	2	{{layout-section ac:type="single"}}
78.1	3	{{layout-cell}}{{/layout-cell}}
30.1	4	{{/layout-section}}
	5
	6	{{layout-section ac:type="two_right_sidebar"}}
	7	{{layout-cell}}
78.1	8
30.1	9	{{/layout-cell}}
	10
	11	{{layout-cell}}
	12	{{scroll-ignore}}
	13	{{panel title="Inhalt"}}
	14
	15
	16	{{toc/}}
	17	{{/panel}}
	18	{{/scroll-ignore}}
78.1	19
	20
	21
	22
30.1	23	{{/layout-cell}}
	24	{{/layout-section}}
	25
	26	{{layout-section ac:type="single"}}
	27	{{layout-cell}}
	28	== Ergebnisse speichern ==
	29
	30	Der ONYX Editor kann Tests für eine freie Durchführung publizieren. Führen Nutzer diese Tests durch, wird das Ergebnis zurück an den ONYX Editor übertragen, welcher es speichert. Dazu bietet der ONYX Editor folgende REST-Schnittstellen an:
	31
	32	{{code title="Ergebnisse speichern"}}
	33	@RestMethod(name = "saveResult2")
	34	public Boolean saveResult(
	35	@RestParam(name = "uniqueId") final String uniqueId,
	36	@RestParam(name = "resultFile") final byte[] resultFile,
	37	@RestParam(name = "params") final Map<String, String> params) {}
	38	{{/code}}
	39
78.1	40
30.1	41
	42	=== Parameter saveResult2 ===
	43
	44	\|(((
	45	uniqueId
	46	)))\|(((
78.1	47	Eindeutige ID, die ONYX WebPlayer und ONYX Editor bei der Ausführung des Tests vereinbart haben
30.1	48	)))
	49	\|(((
	50	resultFile
	51	)))\|(((
78.1	52	Ergebnis-Datei als ZIP-File (QTI-konformes result.xml, ggf. inkl. darin referenzierter Dateien wie User-Uploads oder User-Contents
30.1	53	)))
	54	\|(((
	55	params
	56	)))\|(((
	57	Generische Parameter. Diese werden aktuell ohne weitere Verarbeitung einfach nur gespeichert.
	58	)))
	59
78.1	60
30.1	61
	62	=== returnValue saveResult2 ===
	63
	64	\|(((
	65	boolean
	66	)))\|(((
	67	True bei Erfolg, sonst false
	68	)))
	69
	70	== Ergebnisse speichern (Legacy) ==
	71
78.1	72
30.1	73
	74	{{code title="Ergebnisse speichern (Legacy)"}}
	75	@RestMethod(name = "saveResult")
	76	public Boolean saveResult(
	77	@RestParam(name = "uniqueId") final String uniqueId,
	78	@RestParam(name = "resultFile") final byte[] resultFile) {}
	79	{{/code}}
	80
78.1	81
30.1	82
	83	=== Parameter saveResult2 ===
	84
	85	\|(((
	86	uniqueId
	87	)))\|(((
78.1	88	Eindeutige ID, die ONYX WebPlayer und ONYX Editor bei der Ausführung des Tests vereinbart haben
30.1	89	)))
	90	\|(((
	91	resultFile
	92	)))\|(((
78.1	93	Ergebnis-Datei als ZIP-File (QTI-konformes result.xml, ggf. inkl. darin referenzierter Dateien wie User-Uploads oder User-Contents
30.1	94	)))
	95
	96	=== returnValue saveResult2 ===
	97
	98	\|(((
	99	boolean
	100	)))\|(((
	101	True bei Erfolg, sonst false
	102	)))
	103
78.1	104
30.1	105
	106	== Version der Schnittstelle abfragen ==
	107
78.1	108
30.1	109
	110	{{code title="Version abfragen"}}
	111	@RestMethod(name = "version")
	112	public String version() {}
	113	{{/code}}
	114
78.1	115
30.1	116
	117	=== Parameter version ===
	118
	119	keine
	120
78.1	121
30.1	122
	123	=== returnValue saveResult2 ===
	124
	125	\|(((
	126	String
	127	)))\|(((
	128	Version der REST-Schnittstelle, aktuell immer "1.0 (ONYX-Editor-Version)"
	129	)))
	130
78.1	131
30.1	132
	133	== Nutzer löschen ==
	134
	135	Der ONYX Editor kann an ein LMS gekoppelt werden, so dass das LMS das nutzerdatenführende System ist. Werden Nutzer im LMS gelöscht, so sollten alle zugehörigen Daten (bspw. die persönlichen Einstellungen des Nutzers) auch im ONYX Editor gelöscht werden.
	136
	137	{{code title="Nutzer löschen"}}
	138	@RestMethod
	139	public Map<String, String> deleteUser(
	140	@RestParam(name = "login") final String login,
	141	@RestParam(name = "password") final String password,
	142	@RestParam(name = "repo") final String repo,
	143	@RestParam(name = "property") final String property,
	144	@RestParam(name = "values") final ArrayList<String> values,
	145	@RestParam(name = "reason") final String reason,
	146	@RestParam(name = "params") final Map<String, String> params) {}
	147	{{/code}}
	148
	149	=== Parameter deleteUser ===
	150
	151	\|(((
	152	login
	153	)))\|(((
	154	Username eines ONYX-Editor-Admin-Nutzers, der das Recht hat, andere Nutzer zu löschen.
	155	)))
	156	\|(((
	157	password
	158	)))\|(((
	159	Passwort dieses ONYX-Editor-Admin-Nutzers.
	160	)))
	161	\|(((
	162	repo
	163	)))\|(((
78.1	164	ID des LMS-Repositories, so wie diese im LMS bereits konfiguriert ist und zur Kommunikation mit dem ONYX Editor verwendet wird
30.1	165	)))
	166	\|(((
	167	property
	168	)))\|(((
78.1	169	Selektionskriterium der zu löschenden Nutzer. Wenn "uid", dann wird nach dem gloabl gültigem Nutzer-Identifier (Shibboleth-Kriterium) gefiltert, sonst nach den Nutzernamen, die vom LMS in Verbindung mit dem ONYX Editor intern genutzt werden.
30.1	170	)))
	171	\|(((
	172	values
	173	)))\|(((
	174	Liste der Werte, nach denen gefiltert wird, bspw. Liste der Nutzernamen.
	175	)))
	176	\|(((
	177	reason
	178	)))\|(((
	179	Lösch-Grund. Wird mit ins Lösch-Log geschrieben.
	180	)))
	181	\|(((
	182	params
	183	)))\|(((
	184	Aktuell nicht genutzt
	185	)))
	186
	187	=== returnValue deleteUser ===
	188
	189	Löschresultat-Informationen.
	190
	191	\|(((
	192	Key
	193	)))\|(((
	194	Die Values, wie im Parameter _values_ angegeben
	195	)))
	196	\|(((
	197	Value
	198	)))\|(((
	199	Löschresultat (bspw. _NOT FOUND_, _ERROR:xyz_, ...)
	200	)))
	201	{{/layout-cell}}
	202	{{/layout-section}}
	203	{{/layout}}

Wiki-Quellcode von Schnittstelle ONYX Editor

Suchen

ONYXGlobal

ONYXMenü

Zuletzt besucht