Get Register User

API Type

REST

HTTP Method

POST

Description

Retrieves the user information for the registered user.

URL Format (On Premises)

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

URL Format (AgilePoint for Azure)

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

Request Parameters

Name	Description
None	Not Applicable

Request Body Properties

Name	Description
userName	Definition: The user name for the user. Type string Allowed Values: A valid user name for a registered AgilePoint user.

JavaScript Code Example

$("#btnGetRegisterUser").click(function () {
  var JSONObject = {
    userName: "demo3\\administrator"
  };
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Admin/
                  GetRegisterUser",
    data: JSON.stringify(JSONObject)
  });
});

Java Code Example

public string GetRegisterUser(string userName)
  {
    string URI = "http://mydomain:9011/AgilePointServer/Admin/GetRegisterUser";
           
    string jsonRequestData = "{\"userName\":\""+userName+"\"}";

    HTTPOperations ops = new HTTPOperations(domain, this.userName, 
                         password, appID, locale);
           
    return  ops.POSTMethod(URI, jsonRequestData);
  }

C# Code Example

public string GetRegisterUser(string userName)
  {
    string URI = "http://mydomain:9011/AgilePointServer/Admin/GetRegisterUser";
           
    string jsonRequestData = "{\"userName\":\""+userName+"\"}";

    HTTPOperations ops = new HTTPOperations(domain, this.userName, 
                         password, appID, locale);
           
    return  ops.POSTMethod(URI, jsonRequestData);
  }

Output

RegisteredUser object.

JSON Response Body Example

{
  "Department": "Administrator"
  "EMailAddress": "admin@mycompany.com"
  "FullName": "administrator"
  "Locale": "en-US"
  "Manager": "demo3\Manager"
  "OnlineContact": "admin@mycompany.com"
  "RefID": ""
  "RegisteredDate: " \/Date(928149600000)\/"
  "TimeZone": ""
  "Title": ""
  "UALExpirationDate": " \/Date(928149600000)\/"
  "UALNeverExpires": false
  "UserName": "demo3\administrator"
}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher