RuntimeServiceGetUser Method |
Returns a user definition. Intended for web use only.
Namespace: Advantys.Workflow.Web.Services.Processes.Runtime
Assembly: Advantys.Workflow.Web.Services.Processes.Runtime (in Advantys.Workflow.Web.Services.Processes.Runtime.dll) Version: 7.12.0.21812 (7.12.0.201809102)
SyntaxParameters
- 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: StringUser definition
RemarksAvailable since WorkflowGen version: 6.2.0
Sample filterFields XML to return the first name and last name:
Complete filterFields XML:
Sample code:
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:
XML
<User> <FirstName /> <LastName /> </User>
Complete filterFields XML:
XML
<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:
RuntimeServiceWebService.RuntimeService myRuntimeService = new RuntimeServiceWebService.RuntimeService(); string userDefinition = myRuntimeService.GetUser(username, null);
See Also