Register User

API Type

REST

HTTP Method

POST

Description

Registers a user on the AgilePoint system.

URL Format (On Premises)

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

URL Format (AgilePoint for Azure)

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

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.
RegisteredDate	Definition: Gets and sets date registered. Type DateTime Allowed Values: A valid DateTime value.
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.
UALExpirationDate	Definition: Specifies the user's UAL expiration. Type DateTime Allowed Values: A valid DateTime value.
UALNeverExpires	Definition: Specifies whether UAL for the user expires. Type bool Allowed Values: True - The UAL for the user expires. False - The UAL for the user does not expire.
UserName	Definition: The user name for the user. Type string Allowed Values: A valid user name for a registered AgilePoint user.

JavaScript Code Example

$("#btnRegisterUser").click(function () {
  var JSONObject = {
    Department: "HR",
    EMailAddress: "Bob@tusca.com",
    FullName: "Bob",
    Locale: "en-US",
    Manager: "demo3\\Bill",
    OnlineContact: "",
    RefID: "",
    RegisteredDate: "\/Date(928149600000+0000)\/",
    TimeZone: "",
    Title: "",
    UALExpirationDate: "\/Date(928149600000+0000)\/",
    UALNeverExpires: true,
    UserName: "demo3\\Bob"
  };
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Admin/RegisterUser",
    data: JSON.stringify(JSONObject)
  });
});

Java Code Example

public String RegisterUser(String Department, String EMailAddress,
  String FullName, String Locale, String Manager,
  String OnlineContact, String RefID, String TimeZone, String Title,
  String UserName, Calendar UALExpirationDate, boolean UALNeverExpires) {

  String URI = "http://mydomain:9011/AgilePointServer/Admin/RegisterUser";

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

  try {
    JSONObject postData = new JSONObject();
    postData.put("Department", Department);
    postData.put("EMailAddress", EMailAddress);
    postData.put("FullName", FullName);
    postData.put("Locale", Locale);
    postData.put("Manager", Manager);
    postData.put("OnlineContact", OnlineContact);
    postData.put("RefID", RefID);
    postData.put("TimeZone", TimeZone);
    postData.put("Title", Title);
    postData.put("UserName", UserName);
    postData.put("RegisteredDate", "/Date("
      + Calendar.getInstance().getTimeInMillis() + ")/");
    postData.put("UALExpirationDate",
      "/Date(" + UALExpirationDate.getTimeInMillis() + ")/");
    postData.put("UALNeverExpires", UALNeverExpires);

    return ops.POSTMethod(URI, postData.toString());
  } catch (JSONException e1) {
			e1.printStackTrace();
  }
  return "";
}

C# Code Example

public string RegisterUser()
  {
    string URI = "http://mydomain:9011/AgilePointServer/Admin/RegisterUser";

    string jsonRequestData = "{
      \"Department\":\"\",
      \"EMailAddress\":\"abc@mydomain.com\",
      \"FullName\":\"AmericaBritainCalifornia\",
      \"Locale\":\"\",
      \"Manager\":\"\",
      \"OnlineContact\":\"\",
      \"RefID\":\"\",
      \"RegisteredDate\":\"\\/Date(1357803786593+0530)\\/\",
      \"TimeZone\":\"\",
      \"Title\":\"\",
      \"UALExpirationDate\":\"\\/Date(-62135596800000)\\/\",
      \"UALNeverExpires\":false,
      \"UserName\":\"AP2\\\\abc\"}";

    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