Webservice user
- WSDL Datei
Die zur Nutzung der infra-struktur Benutzerverwaltung Webservices notwendige WSDL-Datei finden Sie unter:
http://demo.infra-struktur.eu/webservice/wsdl/wsdl.php?user
- Funktionsübersicht
Authenticate
Authentifiziert einen Benutzer am Webservice
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| instanceName | String | Vollständiger Pfad der Instanz |
| userName | String | infra-struktur Benutzername |
| password | String | infra-struktur Passwort |
Rückgabewert |
||
| token | String | Authentifizierungstoken für weitere Anfragen am Webservice |
getUserIDByLoginname
Liefert die UserID an hand des Loginnamens
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| LoginName | String | Loginname des Users |
| Token | String | Authentifizierungstoken |
Rückgabewert |
||
| UserID | Integer | UserID des Benutzers |
getUserIDByKuerzel
Liefert das Kürzel UserID an hand des Loginnamens
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| UserKuerzel | String | Kuerzel des Users |
| Token | String | Authentifizierungstoken |
Rückgabewert |
||
| UserID | Integer | UserID des Benutzers |
getUserList
Liefert eine Liste aller im System registrierten Benutzer
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| Token | String | Authentifizierungstoken |
Rückgabewert |
||
| UserList | Array | Alle UserIDs im System |
getUsername
Liefert den Benutzernamen zur angegebenen UserID
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| UserID | Integer | UserID des Benutzers |
| Token | String | Authentifizierungstoken |
Rückgabewert |
||
| UserName | String | Angeforderter Benutzername |
getActiveUserlist
Liefert eine Liste der aktuell aktiven Benutzer
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| Token | String | Authentifizierungstoken |
Rückgabewert |
||
getRealUsernameByUserId
Liefert den vollständigen Benutzernamen anhand der UserID
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| userId | Integer | ID des Benutzers |
| token | String | Authentifizierungstoken |
Rückgabewert |
||
getUserAbbreviationById
Liefert das Kürzel eines Benutzers anhand der UserID
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| userId | Integer | ID des Benutzers |
| token | String | Authentifizierungstoken |
Rückgabewert |
||
getUserstatus
Liefert den aktuellen Status eines Benutzers
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| UserID | Integer | ID des Benutzers |
| Token | String | Authentifizierungstoken |
Rückgabewert |
||
getListOfUserstatus
Liefert eine Liste aller verfügbaren Benutzerstatus
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| token | String | Authentifizierungstoken |
Rückgabewert |
||
getListOfUsersWithStatus
Liefert eine Liste aller Benutzer mit einem bestimmten Status
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| userId | Integer | ID des Benutzers |
| token | String | Authentifizierungstoken |
Rückgabewert |
||
getListOfAutomaticUserstatus
Liefert eine Liste aller automatischen Benutzerstatus
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| token | String | Authentifizierungstoken |
Rückgabewert |
||
setUserstatus
Setzt den Status eines Benutzers
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| userID | Integer | ID des Benutzers |
| userstatusID | Integer | ID des gewünschten Status |
| token | String | Authentifizierungstoken |
Rückgabewert |
||
setUserstatusAvailable
Setzt den Status eines Benutzers auf verfügbar
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| userID | Integer | ID des Benutzers |
| token | String | Authentifizierungstoken |
Rückgabewert |
||
setCustomUserstatus
Setzt einen benutzerdefinierten Status
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| userID | Integer | ID des Benutzers |
| customStatus | String | Benutzerdefinierter Statustext |
| token | String | Authentifizierungstoken |
Rückgabewert |
||
setAutomaticUserstatus
Setzt einen automatischen Status für einen Benutzer
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| userID | Integer | ID des Benutzers |
| automaticStateID | Integer | ID des automatischen Status |
| token | String | Authentifizierungstoken |
Rückgabewert |
||
deleteAutomaticUserstatus
Löscht den automatischen Status eines Benutzers
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| userID | Integer | ID des Benutzers |
| token | String | Authentifizierungstoken |
Rückgabewert |
||
setUserstatusBackgroundColorHex
Setzt die Hintergrundfarbe des Benutzerstatus als Hexadezimalwert
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| userID | Integer | ID des Benutzers |
| hex | String | Hexadezimalwert der Farbe (z.B. #FF0000) |
| token | String | Authentifizierungstoken |
Rückgabewert |
||
deleteUserstatusBackgroundColorHex
Löscht die Hintergrundfarbe des Benutzerstatus
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| userID | Integer | ID des Benutzers |
| token | String | Authentifizierungstoken |
Rückgabewert |
||
refreshTheUseronlineList
Aktualisiert die Liste der online Benutzer
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| token | String | Authentifizierungstoken |
Rückgabewert |
||
