Surrogate With Application Name and Locale

API Type

Web Services

Description

This function is similar to Surrogate, with the ability to set the application name and locale at the same time.Calling the functions SetClientAppName and SetClientLocale is not needed if this function is called.

Syntax

public virtual void Surrogate(string userName, string AppName, string Locale)

Parameters

NameDescription

userName
Function:
The user name for the user.
Type
string
Accepted Values:
A valid user name for a registered AgilePoint user.

AppName
Function:
Specifies the name of the application.
Type
string
Accepted Values:
A valid, case-sensitive application name.

Locale
Function:
Specifies the client locale.
Type
string
Accepted Values:
A valid locale in standardized format.
Example:
en-US

Output

None.

Example

public IWFWorkflowService GetWorkflowService(System.Net.ICredentials
credentials, string userName, string AppName, string Locale)
	{
    IWFWorkflowService svc = GetWorkflowService(credentials);
    svc.Surrogate(userName, surrogate AppName, surrogate Locale);
    return svc;
	}
           
public IWFAdminService GetWorkflowService(System.Net.ICredentials credentials)
	{
    //The body is the same as Surrogate
	}

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.