Update Registered User

API Type

REST

HTTP Method

POST

Description

Updates user data for a registered user.

URL Format (On Premises)

https://[domain]:[port]/AgilePointServer/Admin/UpdateRegisterUser

URL Format (AgilePoint for Azure)

https://[domain]:[port]/AgilePointService/Admin/UpdateRegisterUser

Request Parameters

Name	Description
None	Not Applicable

Request Body Properties

Name	Description
Department	Definition: Gets and sets department of the user. Type string Allowed Values: A valid department name.
EMailAddress	Definition: Gets and sets the user's e-mail address. Type string Allowed Values: A valid e-mail address.
FullName	Definition: Specifies the full name of the user. Type string Allowed Values: A single line of text.
Locale	Definition: Specifies the client locale. Type string Allowed Values: A valid locale in standardized format. Example: en-US
Manager	Definition: Specifies the manager of the user. Type string Allowed Values: A valid user name.
OnlineContact	Definition: Gets and sets online contact of the user. Type string Allowed Values: A valid contact.
RefID	Definition: Specifies the reference ID for the user. Type string Allowed Values: A valid reference ID.
TimeZone	Definition: Specifies the user's time zone. Type string Allowed Values: A valid time zone.
Title	Definition: Specifies the job title of the user. Type string Allowed Values: A single line of text.
UserName	Definition: The user name for the user. Type string Allowed Values: A valid user name for a registered AgilePoint user.

JavaScript Code Example

$("#btnUpdateRegisteredUser").click(function () {
  var JSONObject = { 
    Department: "HR",
    EMailAddress: "admin@tusca.com", 
    FullName: "Administrator",
    Locale: null,
    Manager: "demo3\\administrator",
    OnlineContact: null,
    RefID: null,
    TimeZone: null,
    Title: "SHR",
    UserName: "admin"
  };
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Admin/UpdateRegisterUser",
    data: JSON.stringify(JSONObject)
  });                             
});

Java Code Example

public String UpdateRegisterUser() {

  String URI = "https://mydomain:9011/AgilePointServer/Admin/UpdateRegisterUser";

  HTTPOperations ops = new HTTPOperations(domain, userName, 
                       password, appID, locale);

  
    JSONObject postData = new JSONObject();
    postData.put("Department", "HR");
    postData.put("EMailAddress", "Bob@tusca.com");
    postData.put("FullName", "Bob");
    postData.put("Locale", "en-US");
    postData.put("Manager", "demo3\\Bill");
    postData.put("OnlineContact", "");
    postData.put("RefID", "");
    postData.put("TimeZone", "");
    postData.put("Title", "");
    postData.put("UserName", "demo3\\Bob");

    return ops.POSTMethod(URI, postData.toString());
  return "";
}

C# Code Example

public string UpdateRegisterUser()
  {
    string URI = "https://mydomain:9011/AgilePointServer/Admin/UpdateRegisterUser";

    string jsonRequestData = "{
      \"Department\":\"\",
      \"EMailAddress\":\"peter.parker@agilepoint.com\",
      \"FullName\":\"Peter Parker\",
      \"Locale\":\"\",
      \"Manager\":\"\",
      \"OnlineContact\":\"\",
      \"RefID\":\"\",
      \"TimeZone\":\"\",
      \"Title\":\"\",
      \"UserName\":\"MYDOMAIN\\\\AAMAadmi\"}";

    HTTPOperations ops = new HTTPOperations(domain, this.userName, 
                         password, appID, locale);

    return ops.POSTMethod(URI, jsonRequestData);
  }

Output

None.

JSON Response Body Example

The response body is empty.

Supported Versions

AgilePoint BPMS v5.0 R2 and higher

Parent topic: Administrative Service

Quick Links:

Documentation Library

AgilePoint

AgilePoint BPMS v5.0 R2 SP1 for .NET 3.5, .NET 4.0, and Genesis Edition

AgilePoint BPMS v5.0 SP3 for Universal Edition and Azure