Please enable JavaScript to view this site.

The manual for the JobRouter developer

Navigation: Dashboard API > Methods and objects of the dashboard API > Usable objects

The ApiUser object

 Scroll Prev Top Next More

By means of the methods getUser and getUserByUsername an ApiUser object can be received, enabling you to retrieve the user properties.

The object provides the following methods:

Method

Parameter

Return

Description

getAvatarUrl

-

String

Returns the URL to the user-avatar.

getDateFormat

-

String

Returns the set user format according to ISO 8601.

getDateFormatId

-

String

Returns the date format ID configured for the user.

 

1

dd.mm.yyyy

2

dd/mm/yyyy

3

mm/dd/yyyy

4

yyyy-mm-dd

 

getDecimalSeparator

-

String

Returns the user's decimal separator.

getDepartment

-

String

Returns the user's department.

getEmail

-

String

Returns the user's e-mail-address.

getFullName

-

String

Returns the user's full name (prename surname).

getJobFunctions

-

Array

Returns all Job Functions of the user.

getLanguage

-

String

Returns the user language.

getLastname

-

String

Returns the user's family name.

getPrename

-

String

Returns the user's first name.

getSupervisor

-

String

Returns the user's supervisor.

getThousandsSeparator

-

String

Returns the user's thousand separator.

getUserDefined1

-

String

Returns the user's user-defined field 1.

getUserDefined2

-

String

Returns the user's user-defined field 2.

getUserDefined3

-

String

Returns the user's user-defined field 3.

getUserDefined4

-

String

Returns the user's user-defined field 4.

getUserDefined5

-

String

Returns the user's user-defined field 5.

getUsername

-

String

Returns the user's username.

hasAdminRights

-

Boolean

Verifies whether the user has the administration right.

hasOwnProcesses

-

Boolean

Verifies whether the user is the process owner.

isInJobFunction

string $jobfunction

Boolean

Verifies whether the user has the indicated job function.