Please enable JavaScript to view this site.

Das Handbuch für den JobRouter Entwickler

Navigation: Webservice > Funktionsweise & Verwendung > Benutzerverwaltung

getUsers

Scroll Zurück Oben Weiter Mehr

Sämtliche Benutzer abfragen

Die Methode getUsers liefert alle aktuell in JobRouter vorhandenen Benutzer zurück. Beim Aufruf der Methode dürfen hierbei keine Daten als Suchfilter übergeben werden.

Auf Wunsch lassen sich die Inhalte der benutzerdefinierten Felder sowie die globalen Benutzerrechte der einzelnen Benutzer mit zurückgeben.

Die Rückgabe besteht aus einer Liste von Benutzer-Objekten. Über diese Objekte ist ein einfacher Zugriff auf sämtliche Daten, benutzerdefinierten Felder und Benutzerrechte der einzelnen Benutzer möglich.

Falls keine Benutzer in JobRouter vorhanden sind, wird ein Fehler zurückgeliefert.

Gezielte Suche nach bestimmten Benutzern durchführen

Die Methode getUsers bietet neben der Rückgabe sämtlicher vorhandenen Benutzer zusätzlich die Möglichkeit, durch Angabe eines Suchfilters die Menge der zurückgelieferten Benutzer gezielt einzugrenzen.

Weiterhin lassen sich auf Wunsch die Inhalte der benutzerdefinierten Felder sowie die globalen Benutzerrechte der einzelnen Benutzer mit zurückgeben.

Die Rückgabe besteht aus einer Liste von Benutzer-Objekten. Über diese Objekte ist ein einfacher Zugriff auf sämtliche Daten, benutzerdefinierten Felder und Benutzerrechte der einzelnen Benutzer möglich.

Falls keine zum beim Aufruf angegebenen Suchfilter passenden Benutzer gefunden wurden, wird ein Fehler zurückgeliefert.

Methodenreferenz

Parameter

Datentyp

Beschreibung

kvpList

ServiceObject_KeyValuePair[]

Array mit Suchdaten als Schlüssel-Wert-Paare

includeCustomUserData

bool

Flag, ob die Inhalte der benutzerdefinierten Felder ebenfalls zurückgeliefert werden sollen

includeUserRights

bool

Flag, ob die Benutzerrechte ebenfalls mit zurückgeliefert werden sollen

Rückgabe: ServiceObject_User[]; Array mit Benutzerobjekten