Webservice user: Unterschied zwischen den Versionen

Aus infra-struktur AdminWiki 2.10
Zur Navigation springenZur Suche springen
← Zum vorherigen Versionsunterschied
Keine Bearbeitungszusammenfassung
Keine Bearbeitungszusammenfassung
 
(8 dazwischenliegende Versionen von 4 Benutzern werden nicht angezeigt)
Zeile 3: Zeile 3:
Die zur Nutzung der infra-struktur Benutzerverwaltung Webservices notwendige WSDL-Datei finden Sie unter:
Die zur Nutzung der infra-struktur Benutzerverwaltung Webservices notwendige WSDL-Datei finden Sie unter:


http://instanzname.infra-struktur.de/webservice/wsdl/wsdl.php?user
http://demo.infra-struktur.eu/webservice/wsdl/wsdl.php?user
 
Beachten Sie, dass der Webserver für die Verwendung der Webservices Schreibrechte auf das Verzeichnis „WEBROOT/webservice/wsdl“ benötigt.
 
* '''Example'''
 


* '''Funktionsübersicht'''
* '''Funktionsübersicht'''
Zeile 96: Zeile 91:




''<u>getUserName</u>''
''<u>getUsername</u>''


Liefert den Benutzernamen zur angegebenen UserID
Liefert den Benutzernamen zur angegebenen UserID
Zeile 115: Zeile 110:
| UserName|| String||| Angeforderter Benutzername
| UserName|| String||| Angeforderter Benutzername
|}
|}
''<u>getActiveUserlist</u>''
Liefert eine Liste der aktuell aktiven Benutzer
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| Token    || String ||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
''<u>getRealUsernameByUserId</u>''
Liefert den vollständigen Benutzernamen anhand der UserID
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userId    ||Integer ||| ID des Benutzers
|-
| token    || String ||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
''<u>getUserAbbreviationById</u>''
Liefert das Kürzel eines Benutzers anhand der UserID
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userId    ||Integer ||| ID des Benutzers
|-
| token    || String ||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
''<u>getUserstatus</u>''
Liefert den aktuellen Status eines Benutzers
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID    ||Integer ||| ID des Benutzers
|-
| Token    || String ||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
''<u>getListOfUserstatus</u>''
Liefert eine Liste aller verfügbaren Benutzerstatus
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| token    || String ||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
''<u>getListOfUsersWithStatus</u>''
Liefert eine Liste aller Benutzer mit einem bestimmten Status
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userId    ||Integer ||| ID des Benutzers
|-
| token    || String ||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
''<u>getListOfAutomaticUserstatus</u>''
Liefert eine Liste aller automatischen Benutzerstatus
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| token    || String ||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
''<u>setUserstatus</u>''
Setzt den Status eines Benutzers
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userID    ||Integer ||| ID des Benutzers
|-
| userstatusID    ||Integer ||| ID des gewünschten Status
|-
| token    || String ||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
''<u>setUserstatusAvailable</u>''
Setzt den Status eines Benutzers auf verfügbar
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userID    ||Integer ||| ID des Benutzers
|-
| token    || String ||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
''<u>setCustomUserstatus</u>''
Setzt einen benutzerdefinierten Status
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userID    ||Integer ||| ID des Benutzers
|-
| customStatus    ||String ||| Benutzerdefinierter Statustext
|-
| token    || String ||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
''<u>setAutomaticUserstatus</u>''
Setzt einen automatischen Status für einen Benutzer
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userID    ||Integer ||| ID des Benutzers
|-
| automaticStateID    ||Integer ||| ID des automatischen Status
|-
| token    || String ||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
''<u>deleteAutomaticUserstatus</u>''
Löscht den automatischen Status eines Benutzers
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userID    ||Integer ||| ID des Benutzers
|-
| token    || String ||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
''<u>setUserstatusBackgroundColorHex</u>''
Setzt die Hintergrundfarbe des Benutzerstatus als Hexadezimalwert
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userID    ||Integer ||| ID des Benutzers
|-
| hex    ||String ||| Hexadezimalwert der Farbe (z.B. #FF0000)
|-
| token    || String ||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
''<u>deleteUserstatusBackgroundColorHex</u>''
Löscht die Hintergrundfarbe des Benutzerstatus
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userID    ||Integer ||| ID des Benutzers
|-
| token    || String ||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
''<u>refreshTheUseronlineList</u>''
Aktualisiert die Liste der online Benutzer
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| token    || String ||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
== Hauptkapitel ==
* [[Webservice Dokumentation]]
== Verwandte Themen ==
* [[Webservice_activities]]
* [[Webservice_calendar]]
* [[Webservice_contacts]]
* [[Webservice_dms]]
* [[Webservice_dmstagging]]
* [[Webservice_ido]]
* [[Webservice_idolinkings]]
* [[Webservice_msg]]
* [[Webservice_user]]
* [[Webservice_email]]
* [[Webservice_task]]

Aktuelle Version vom 13. Mai 2026, 11:57 Uhr

  • 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


Hauptkapitel

Verwandte Themen

Abgerufen von „https://adminwiki210.infra-struktur.de/index.php?title=Webservice_user&oldid=2800“