RuntimeService.GetUser Method

Namespace: Advantys.Workflow.Web.Services.Processes.Runtime
Assembly: Advantys.Workflow.Web.Services.Processes.Runtime (in Advantys.Workflow.Web.Services.Processes.Runtime.dll) Version: 6.6.0.0 (6.6.0.0)

Syntax

Copy

public string GetUser(
	string username,
	string filterFields
)

Public Function GetUser ( 
	username As String,
	filterFields As String
) As String

Parameters

username: Type: SystemString
Username of the user to get.
filterFields: Type: SystemString
XML structure of a user definition containing only the desired fields. If left null or empty, the entire definition will be returned. Element names are case sensitive.

Return Value

Type: String
User definition

Remarks

Available since WorkflowGen version: 6.2.0

Optional Parameters.

These parameters can be used in the query string or as parameters of the Headers object in the RuntimeService class instance. See example below.

UserId (int)

Specifies the Id of the participant to get. Supercedes the participant name.

Sample filterFields XML to return the first name and last name:

Copy

<User>
 <FirstName />
 <LastName />
</User>

Complete filterFields XML:

Copy

<User>
 <ID />
 <Directory />
 <DateCreation />
 <DateUpdate />
 <FirstName />
 <LastName />
 <Username />
 <Email />
 <Profile />
 <Active />
 <Synchronized />
 <DefaultLanguage />
 <DefaultTimeZoneId />
 <ReadOnly />
 <BuiltIn />
 <Phone />
 <Mobile />
 <Fax />
 <Pager />
 <Office />
 <Department />
 <Company />
 <JobTitle />
 <EmployeeType />
 <Initials />
 <Title />
 <EmployeeNumber />
 <PostalAddress />
 <PostalCode />
 <City />
 <State />
 <Country />
 <LDAP_ADsPath />
 <CommonName />
 <DistinguishedName />
 <Archive />
 <DateArchive />
 <DateLastVisit />
 <ExtendedAttribute1 />
 <ExtendedAttribute2 />
 <ExtendedAttribute3 />
 <ExtendedAttribute4 />
 <ExtendedAttribute5 />
 <SystemIdentifier />
 <Manager />
 <DateActivation />
 <Groups />
</User>

Sample code:

Copy

RuntimeServiceWebService.RuntimeService myRuntimeService = new RuntimeServiceWebService.RuntimeService();        

string userDefinition = myRuntimeService.GetUser(username, null);

Reference

RuntimeService Class

Advantys.Workflow.Web.Services.Processes.Runtime Namespace