Objekte

global

"Globale" Methoden

set_session
Setzt die Session-ID der aktuellen Sitzung. Muss die erste aufgerufene Methode sein, falls vorhanden.
session_id *string
104
105
106
set_options
Setzt diverse globale Optionen.
localeen
de
fr
es
it
tr
outputserialized
strings
session_timeoutint
timeoutfloat
get_nonce
Nonce fuer Login generieren
login
Knuepft Session an einen Benutzer (hex)hash=algorithm(nonce_key+salt+token).
login *string
algorithmmd5
sha1
sha256
sha512
applicationstring
cryptstring
get_miniaturebool
get_propertiesmixed
hashstring
is_hiddenbool
is_onlinebool
is_volatilebool
nonce_idstring
passwordstring
saltstring
107
108
reload
Login-Informationen neu lesen
get_miniaturebool
get_propertiesmixed
logout
Benutzer abmelden und Session zerstoeren.
set_focus
Setzt Focus auf User (default: keine Aenderung) und "Objekt".
object *administration
mailbox
messenger
members
addresses
calendar
tasks
notes
board
board_teacher
board_pupil
forum
licenses
files
member
resource_management
external
session_files
profile
messages
wiki
settings
proxy
trusts
courselets
loginstring
uidstring
109
110
112
statistics
sysadmin
Verschiendene Infos
forward_event
Weitergeleitetes Event (interne Verwendung)
data *mixed
event *string
source *string

administration.group

Gruppen/Klassen-Administration

get_defaults
admin
Liefert Default-Mitgliedsrechte nach Rolle
128
129
130
set_defaults
admin_admin
Setzt Default-Mitgliedsrechte fuer eine Rolle
member_rights *array
member_type *int
property *default_member_rights
117
118
119
120
121
122
123
124
125
126
127
get_users
admin
Liefert Mitgliederliste
limitint
offsetint
typeint
join_user
admin_write
User in Gruppe/Klasse aufnehmen
is_adminbool
is_moderatorbool
loginstring
uidstring
144
145
146
set_user
admin_admin
Aendert Benutzer
loginstring
member_rightsarray
uidstring
140
141
142
143
266
leave_user
admin_admin
User aus Gruppe/Klasse entfernen
loginstring
uidstring
147
148
149
150

administration.user

Nutzer-Administration

get_profile
admin
Profile lesen
export_imagebool
include_empty_fieldsbool
set_profile
admin_admin
Setzt Felder des Profils (Felder variieren)
auxiliarystring
import_profile_image
admin_admin
Profil-Bild aus Session-Datei importieren (*.jpg, max. 200 x 200 Pixel)
id *string
delete_profile_image
admin_admin
Profil-Bild loeschen
get_crypt
sysadmin
Passwort-Crypt lesen (Replikation)
set_gtac
sysadmin
GTAC setzen (Replikation)
version *int
dateint

administration.root

Institutions-Administration

get_mappings
admin
Liefert Liste der Mappings (Zuordnungen)
typeint
add_mapping
admin_write
Erstellt neues Mapping
name *string
type *int
sub_type1
2
131
set_mapping
admin_write
Aendert Mapping
id *int
namestring
132
delete_mapping
admin_write
Loescht (leeres) Mapping
id *int
133
134
get_max_base_rights
admin
Liefert Maximalrechte nach Typ
get_max_quotas
admin
Liefert Maximalquoten nach Typ
get_defaults
admin
Liefert Default-Rechte und -Quoten nach Rolle fuer Institution oder Default-Mitgliedsrechte fuer angegebene Gruppe
loginstring
128
129
130
set_defaults
admin_admin
Setzt Default-Rechte und -Quoten nach Rolle fuer Institution oder Default-Mitgliedsrechte fuer angegebene Gruppe
property *default_quotas
default_base_rights
default_member_rights
base_rightsarray
blog_quotaint
courselets_quotaint
external_quotaint
file_quotaint
forum_quotaint
image_quotaint
learning_log_quotaint
loginstring
mail_quotaint
member_rightsarray
member_typeint
typeint
wall_quotaint
web_quotaint
wiki_quotaint
117
118
119
120
121
122
123
124
125
126
127
get_users
admin
Liefert Userliste
limitint
memberbool
offsetint
typeint
135
136
get_user
admin
Liefert Infos ueber User
authenticationbool
loginstring
memberbool
quotasbool
statisticsbool
uidstring
135
136
add_user
admin_write
Erstellt neues Konto (Nutzer oder Raum)
type *int
user_name *string
aliasstring
authentication_emailaddressstring
cryptstring
fullnamestring
is_adminbool
mappingint
mapping1int
mapping2int
passwordstring
password_must_changebool
registrationarray
trusts_register_masterarray
uidstring
137
138
139
228
229
set_user
admin_admin
Aendert Konto
aliasstring
authentication_emailaddressstring
authentication_mobilestring
base_rightsarray
base_userstring
blog_quotaint
courselets_quotaint
cryptstring
descriptionstring
external_quotaint
file_quotaint
forum_quotaint
fullnamestring
grant_base_rightstring
image_quotaint
is_easyint
is_enabledint
is_profileint
is_usedbool
is_visibleint
learning_log_quotaint
loginstring
mail_filter_forwardstring
mail_filter_forward_and_stopstring
mail_quotaint
mappingint
mapping1int
mapping2int
member_rightsarray
moderatorstring
passwordstring
password_must_changebool
revoke_base_rightstring
trusts_register_masterarray
trusts_register_slavearray
uidstring
user_namestring
wall_quotaint
web_quotaint
webuntis_idstring
wiki_quotaint
140
141
142
143
227
228
229
266
join_user
admin_write
Externen Nutzer in Institution aufnehmen
loginstring
uidstring
144
145
146
leave_user
admin_admin
Externen User aus Institution entfernen
loginstring
uidstring
147
148
149
150
delete_user
admin_admin
Loescht Benutzerkonto
loginstring
uidstring
151
152
153
154
subscribe_user_to_cms_course
admin
User bei CMS-Kurs anmelden (OPTIONAL)
course_id *int
login *string
155
156
157
add_sub_host
sysadmin
Neuen Sub-Host anlegen
host_name *string
fullnamestring
236
237
238

messenger

Messenger

get_users
messenger
"Holt" Userliste
get_miniaturesbool
only_onlinebool
get_profile
messenger
Liest Profil eines Nutzers (optional, ignoriert Sichtbarkeit einzelner Felder)
login *string
export_imagebool
264
265
read_quick_messages
Liest Quickmessages, wenn vorhanden
export_session_filebool
send_quick_message
messenger_write
Schickt Quickmessage an User
login *string
import_session_filestring
textstring
113
114
115
116
join_user
messenger_write
User in Messenger aufnehmen
login *string
144
145
146
leave_user
messenger_write
User aus Messenger entfernen
login *string
147
148
149
150
get_history
messenger
Verlauf lesen
start_idint

mailbox

Mailservice

get_state
mail
Status (Quote, # ungelesen)
send_mail
mail_write
Schickt E-Mail an Empfaenger (Parameter add_to_sent_folder ist mittlerweile funktionslos)
subject *string
to *string
add_to_sent_folderbool
bccstring
body_plainstring
ccstring
import_session_filesarray
textstring
111
get_folders
mail
Ordnerliste
get_messages
mail
Nachrichten im Ordner
folder_id *string
247
read_message
mail
Nachricht lesen
folder_id *string
message_id *int
248
249
export_session_file
mail
Session-Datei (Attachment) aus Nachricht exportieren
file_id *string
folder_id *string
message_id *int
267

members

Mitgliederliste

get_users
members
"Holt" Userliste
get_miniaturesbool
only_onlinebool
send_quick_message
members_write
Schickt Quickmessage an alle Nutzer des Raums
import_session_filestring
textstring

member

Eigene Mitgliedschaft in Container

join
Mitglied werden
passwordstring
256
leave
Mitgliedschaft beenden
257

addresses

Adressbuch

get_entries
address
"Holt" Adressbucheintraege
add_entry
address_write
Neuen Adressbucheintrag erstellen
birthdaystring
businesscitystring
businesscoordsstring
businesscountrystring
businessfaxstring
businessphonestring
businesspostalcodestring
businessstatestring
businessstreetstring
businessstreet2string
businessstreet3string
categoriesstring
companystring
companytypestring
email2addressstring
email3addressstring
emailaddressstring
firstnamestring
fullnamestring
genderint
hobbystring
homecitystring
homecoordsstring
homecountrystring
homefaxstring
homephonestring
homepostalcodestring
homestatestring
homestreetstring
homestreet2string
homestreet3string
jobtitlestring
jobtitle2string
lastnamestring
middlenamestring
mobilephonestring
nicknamestring
notesstring
subjectsstring
suffixstring
titlestring
uidstring
webpagestring
158
159
160
set_entry
address_write
Adressbucheintrag veraendern
id *string
birthdaystring
businesscitystring
businesscoordsstring
businesscountrystring
businessfaxstring
businessphonestring
businesspostalcodestring
businessstatestring
businessstreetstring
businessstreet2string
businessstreet3string
categoriesstring
companystring
companytypestring
email2addressstring
email3addressstring
emailaddressstring
firstnamestring
fullnamestring
genderint
hobbystring
homecitystring
homecoordsstring
homecountrystring
homefaxstring
homephonestring
homepostalcodestring
homestatestring
homestreetstring
homestreet2string
homestreet3string
jobtitlestring
jobtitle2string
lastnamestring
middlenamestring
mobilephonestring
nicknamestring
notesstring
subjectsstring
suffixstring
titlestring
uidstring
webpagestring
delete_entry
address_write
Adressbucheintrag loeschen
id *string
161
162

calendar

Kalender

get_entries
calendar
"Holt" Kalendereintraege
add_entry
calendar_write
Neuen Kalendereintrag erstellen
title *string
descriptionstring
end_datesigned_int
end_date_isostring
locationstring
rrulestring
start_datesigned_int
start_date_isostring
uidstring
168
set_entry
calendar_write
Kalendereintrag veraendern
id *string
descriptionstring
end_datesigned_int
end_date_isostring
locationstring
rrulestring
start_datesigned_int
start_date_isostring
titlestring
uidstring
169
170
delete_entry
calendar_write
Kalendereintrag loeschen
id *string
171
172

notes

Notizen

get_entries
notes
"Holt" Notizen
get_propertiesmixed
add_entry
notes_write
Neue Notiz erstellen
text *string
title *string
colorint
173
set_entry
notes_write
Notiz veraendern
id *string
colorint
textstring
titlestring
174
175
delete_entry
notes_write
Notiz loeschen
id *string
176
177

board

Mitteilungen

get_entries
board
"Holt" Mitteilungen
get_propertiesmixed
add_entry
board_write
Neue Mitteilungen erstellen
text *string
title *string
colorint
kill_dateint
173
set_entry
board_write
Mitteilung veraendern
id *string
colorint
kill_dateint
textstring
titlestring
174
175
delete_entry
board_write
Mitteilung loeschen
id *string
176
177

board_teacher

Lehrerboard

get_entries
board
"Holt" Mitteilungen
get_propertiesmixed
add_entry
board_write
Neue Mitteilungen erstellen
text *string
title *string
colorint
kill_dateint
173
set_entry
board_write
Mitteilung veraendern
id *string
colorint
kill_dateint
textstring
titlestring
174
175
delete_entry
board_write
Mitteilung loeschen
id *string
176
177

board_pupil

Schuelerboard

get_entries
board
"Holt" Mitteilungen
get_propertiesmixed
add_entry
board_write
Neue Mitteilungen erstellen
text *string
title *string
colorint
kill_dateint
173
set_entry
board_write
Mitteilung veraendern
id *string
colorint
kill_dateint
textstring
titlestring
174
175
delete_entry
board_write
Mitteilung loeschen
id *string
176
177

tasks

Aufgaben

get_entries
tasks
"Holt" Aufgaben
add_entry
tasks_write
Neue Aufgabe erstellen
title *string
completedint
descriptionstring
due_dateint
start_dateint
163
set_entry
tasks_write
Aufgabe veraendern
id *string
completedint
descriptionstring
due_dateint
start_dateint
titlestring
164
165
delete_entry
tasks_write
Aufgabe loeschen
id *string
166
167

courselets

Courselets

get_state
Status (Quote, Version der Runtime)
get_configuration
Konfiguration
get_progress
Kumulierter Lernerfolg aller begonnenen Courselets (Lernerfolgskontrolle)
get_propertiesmixed
idsarray int
sinceint
add_result
courselets
Aktuelle Seite setzen und Ergebnis (Punkte) hinzufuegen
id *int
page_id *string
scoreint
timeint
251
252
set_suspend_data
courselets
Suspend-Daten fuer Courselet ueberschreiben (JSON)
id *int
suspend_data *string
if_latestint
253
254
get_results
courselets
Detailierter Lernerfolg eines Courselets
id *int
255
delete_results
courselets
Ergebnisse fuer eine Seite oder Ergebnisse und Suspend-Daten fuer gesamtes Courselet loeschen
id *int
page_idstring
250
add_bookmark
courselets
Lesezeichen anlegen
id *int
258
delete_bookmark
courselets
Lesezeichen loeschen
id *int
259
export_runtime
Runtime als Session-Datei exportieren
get_templates
Liste der Templates
export_template
Template als Session-Datei exportieren
id *string
package
offline
scorm
260
get_mappings
courselets
Liste der Mappings
add_mapping
courselets_write
Erstellt neues Mapping
name *string
set_mapping
courselets_write
Aendert Mapping
id *int
namestring
delete_mapping
courselets_write
Loescht (leeres) Mapping
id *int
get_courselets
courselets
Liste der Courselets
get_propertiesarray
import_courselet
courselets_write
Courselet aus Session-Datei importieren
id *string
is_visibleint
mappingint
241
242
243
244
export_courselet
courselets
Courselet als Session-Datei exportieren
id *string
package
offline
scorm
239
240
delete_courselet
courselets_write
Courselet loeschen
id *string
245
246

forum

Forum

get_state
forum
Status (Quote, Einstellungen)
get_entry
forum
"Holt" einen Beitrag
id *string
232
get_entries
forum
"Holt" alle Beitraege
parent_idstring
add_entry
forum_write
Neuen Beitrag/Thread erstellen
icon *0
1
2
3
4
5
parent_id *string
text *string
title *string
import_session_filestring
import_session_filesarray
reply_notification_mebool
178
179
230
231
delete_entry
forum_admin
Beitrag loeschen
id *string
180
export_session_file
forum
Session-Datei aus Forumsbeitrag exportieren
file_id *string
id *string
226

wiki

Wiki

get_page
wiki
Seite (Source) lesen
namestring

resource_management

Ressourcenmanagement

get_resources
resource_management
"Holt" Ressourcen
add_resource
resource_management_admin
Neue Ressource erstellen
title *string
descriptionstring
is_brokenbool
is_disabledbool
mappingint
213
set_resource
resource_management_admin
Ressource veraendern
id *string
descriptionstring
is_brokenbool
is_disabledbool
mappingint
titlestring
213
delete_resource
resource_management_admin
Ressource loeschen
id *string
get_bookings
resource_management
Liste der Buchungen einer Ressource
id *string
214
add_bookings
resource_management_write
Ressource buchen, "bookings" ist entweder [["day"=>int,"slot_id"=>int,"description"=>string],...) oder "csv": day;slot_id;description\n123;1;(..)\n ...
bookings *mixed
id *string
215
216
217
delete_bookings
resource_management_write
Buchung stornieren, "bookings" ist entweder [["day"=>int,"slot_id"=>int],...) oder "csv": day;slot_id\n123;1\n ...
bookings *mixed
id *string
215
216
217
get_mappings
resource_management
"Holt" Liste der Mappings
add_mapping
resource_management_admin
Erstellt neues Mapping
name *string
set_mapping
resource_management_admin
aendert Mapping
id *int
namestring
delete_mapping
resource_management_admin
Loescht (leeres) Mapping
id *int
212
get_settings
resource_management
Settings lesen
set_settings
resource_management_admin
Settings schreiben (day+is_enabled, day=1..7 oder slot_id+start+end, slot_id=0..24)
dayint
endstring
is_enabledbool
slot_idint
startstring

files

Dateiablage

get_state
files
Status (Quote, Proxy)
get_quota
files
Ausnutzung der Quote (deprecated -> get_state)
get_settings
files_admin
Liest Einstellungen
set_settings
files_admin
Schreibt Einstellungen
upload_notification_add_loginstring
upload_notification_delete_loginstring
upload_notification_mebool
get_entries
files
Liest gesamten Inhalt
folder_idstring
get_file_download_urlbool
get_filesbool
get_foldersbool
get_rootbool
limitint
offsetint
recursivebool
search_optionword_equals
word_starts_with
word_contains
phrase
search_stringstring
182
get_file
files
Download der angegebenen Datei
id *string
limitint
offsetint
183
184
185
get_file_download_url
files
Temporaere Download-URL der angegebenen Datei
id *string
183
184
185
get_file_proxy_nonce
files
Nonce zum Download der Datei ueber einen Proxy
id *string
183
184
185
add_file
files_write
Upload einer neuen Datei
data *string
folder_id *string
name *string
descriptionstring
199
200
201
add_sparse_file
files_write
Reservieren von Speicherplatz fuer Datei, Rueckgabe: sparse_key
folder_id *string
name *string
size *int
descriptionstring
199
200
201
import_session_file
files_write
Session-Datei in Dateiablage importieren
id *string
create_copybool
descriptionstring
file_idstring
folder_idstring
sparse_keystring
202
203
204
205
206
207
export_session_file
files
Session-Datei aus Dateiablage exportieren
id *string
186
187
delete_file
files_write
Loeschen der angegebenen Datei
id *string
192
193
194
add_folder
files_write
Anlegen des angegebenen (leeren) Ordners
folder_id *string
name *string
descriptionstring
208
209
210
211
delete_folder
files_write
Loeschen des angegebenen Ordners
id *string
195
196
197
198
set_file
files_write
Aendert Datei
id *string
descriptionstring
download_notification_add_loginstring
download_notification_delete_loginstring
download_notification_mebool
folder_idstring
namestring
188
189
set_folder
files_write
Aendert Verzeichnis
id *string
descriptionstring
folder_idstring
namestring
readablebool
upload_notification_add_loginstring
upload_notification_delete_loginstring
upload_notification_mebool
writablebool
190
191

external

Externe Dateien (Zugriff nur ueber SOAP)

set_custom_variables
client
Setzt selbst zu benennende Variablen
auxiliarystring
181
get_custom_variables
client
Liest selbst zu benennende Variablen
get_state
client
Status (Quote)
get_quota
client
Ausnutzung der Quote (deprecated -> get_state)
get_entries
client
Liest gesamten Inhalt
folder_idstring
get_filesbool
get_foldersbool
get_miniaturesbool
get_rootbool
limitint
offsetint
recursivebool
182
get_file
client
Download der angegebenen Datei
id *string
limitint
offsetint
183
184
185
add_file
client
Upload einer neuen Datei
data *string
folder_id *string
name *string
descriptionstring
miniature_datastring
201
import_session_file
client
Session-Datei in Dateiablage importieren
folder_id *string
id *string
create_copybool
descriptionstring
miniature_datastring
202
203
204
205
206
207
export_session_file
client
Session-Datei aus Dateiablage exportieren
id *string
186
187
delete_file
client
Loeschen der angegebenen Datei
id *string
192
193
194
add_folder
client
Anlegen des angegebenen (leeren) Ordners
folder_id *string
name *string
descriptionstring
208
209
210
211
delete_folder
client
Loeschen des angegebenen Ordners
id *string
195
196
197
198
set_file
client
Aendert Datei
id *string
descriptionstring
folder_idstring
miniature_datastring
namestring
188
189
set_folder
client
Aendert Verzeichnis
id *string
descriptionstring
folder_idstring
namestring
readablebool
writablebool
190
191

session_files

Temporaere Dateien

add_file
self
Upload einer neuen Datei
data *string
name *string
199
200
201
append_file
self
Anhaengen von Daten an eine Datei
data *string
id *string
218
delete_file
self
Loeschen der angegebenen Datei
id *string
192
193
194
219
get_file
self
Download der angegebenen Datei
id *string
limitint
offsetint
183
184
185
220
get_file_download_url
self
Temporaere Download-URL der angegebenen Datei
id *string
183
184
185
220
get_file_upload_url
self
URL, an die eine neue Datei per PUT geschickt werden kann
name *string
183
184
185
220

licenses

Lizenzverwaltung

get_licenses_for
self
"Holt" Lizenz-Schluessel zu angegebenem Produkt (deprecated)
name *string
recursivebool
use_license
self
Verbraucht falls moeglich eine Lizenz fuer den User aus allen moeglichen Quellen
name *string
type *string
221
add_license
self
Lizenz in die Lizenzverwaltung aufnehmen
key *string
name *string
only_known_and_validbool
222

profile

Profil (des eingeloggten Users)

get_profile
self
Liest Profil
export_imagebool
set_profile
profile_write
Setzt Felder des Profils (Felder variieren)
auxiliarystring
export_image
self
Profil-Bild aus Session-Datei exportieren
delete_image
profile_write
Profil-Bild loeschen
import_image
profile_write
Profil-Bild aus Session-Datei importieren (*.jpg, max. 200 x 200 Pixel)
id *string
262
263

messages

Systemnachrichten

get_messages
self
"Holt" Nachrichtenliste
peekbool
start_idint
delete_message
self
Loescht Nachricht
idint

settings

Einstellungen

register_service
self
Service/Geraet registrieren
service *apns
fcm
gcm
test
token *string
applicationstring
is_onlinebool
unregister_service
self
Service/Geraet deregistrieren
service *apns
fcm
gcm
test
token *string

proxy

Proxy fuer Dateiablagen

verify_authentication_nonce
self
Vom Proxy uebergebene Nonce verifizieren
nonce *string
223

trusts

Vertrauensbeziehungen

register_master
self
Erstellt ein Auth-Token fuer den Nutzer. Muss im Login-Request aufgerufen werden.
remote_application *string
remote_title *string
is_bidirectionalbool
is_replicationbool
remote_hoststring
remote_identstring
224
233
unregister_master
self
Loescht beim Login benutztes Auth-Token.
225
get_url_for_autologin
self
URL fuer Browser zurueckgeben, die den Nutzer einmalig automatisch einloggt
disable_logoutbool
disable_reception_of_quick_messagesbool
enslave_sessionbool
localeen
de
fr
es
it
tr
ping_masterbool
session_timeoutint
target_datamixed
target_iframesbool
target_url_pathstring
register_substitute
self
Temporaere Zugangsdaten erzeugen. Muss im Login-Request aufgerufen werden.
service *webdav
imap
smtp
pop3
timeout *int
namestring
234
235
change_password
password
Aendert Passwort fuer den Nutzer. Muss im Login-Request aufgerufen werden.
password *string
261

 

 
100
101
102
103
9999