Add Group Member

API Type

Web Services

Description

Adds a user to the specified AgilePoint group.

Syntax

public virtual WFGroupMember AddGroupMember(string GroupName, string UserName, string Description, string ClientData, bool Enabled)

Parameters

Name	Description
GroupName	Function: Specifies the name of a group. Type string Accepted Values: A valid group name.
UserName	Function: The user name for the user. Type string Accepted Values: A valid user name for a registered AgilePoint user.
Description	Function: A description of an entity. Type string Accepted Values: A string that can contain spaces and special characters.
ClientData	Function: Specifies the client data, which identifies a client for AgilePoint Server. Type string Accepted Values: A string that contains the client data. If this value is null, the system will keep existing client data. Otherwise the relevant data is overwritten.
Enabled	Function: Enables or disables an entity. Type bool Accepted Values: True - Enables the entity. False - Disables the entity.

Output

WFGroupMember object that contains the data for the new group member.

Example

IWFAdminService svc = GetAdminService();
string GroupName = ...;
string Description = ...;
string UserName = @"[Domain Name]\[Account Name]", // Group Lead User Name
string ClientData = null;
bool Enabled = true;

try
    {
    WFGroup group = svc.AddGroupMember(GroupName, UserName, Description,
    ClientData, Enabled);
    }

catch( Exception ex )
    {
    Console.WriteLine("Failed! " + ShUtil.GetSoapMessage(ex));
    }

Supported Versions

3.2.0.4 and higher

Code Examples in the AgilePoint NX Documentation

The AgilePoint NX Product Documentation is intended as a basic reference to help you understand how to complete basic coding tasks, such as make API or JavaScript method calls. Code examples that show specific use cases, the solutions to specific business problems, or detailed implementation scenarios are outside the scope of the AgilePoint NX Product Documentation. For specific and/or advanced types of examples that may better meet your requirements, AgilePoint provides several resources:

AgilePoint Community Forums - A free, AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.