API Call Samples

We reserve the right to log and verify your API calls and to contact you if we detect abuse on your part. For example:
  • the requests takes too long to return
  • the requests return too much data at a time
  • The requests are too frequent
We strongly suggest using the date filter parameters to return only the data that is relevant.
Select category  

Select function  

Function Details
Name Guid Required Description
AssignUserProject True Assigns a user to an existing project. You must be an administrator or the project's project manager to access this function for a specific project.

Code Sample (Visual Basic, Dotnet Framework 4.x): 
Public Class Sample
	
	Public Sub CodeSample_assignuserproject()
		Dim params = New NameValueCollection From {
					{"fct", "assignuserproject"},
					{"guid", "###"},
					{"userid", "###"},
					{"projectid", "###"}
		}

		Dim jsonText = apiCall(params)

		' https://www.newtonsoft.com/json suggested for JSON parsing to DotNet framework 4.x
		Dim jsonObj = Newtonsoft.Json.Linq.JObject.Parse(jsonText)

		Dim success = jsonObj.Item("status").ToString <> "fail"
		Dim jResults = DirectCast(jsonObj.Item("results"), Newtonsoft.Json.Linq.JArray)

		
	End Sub
	    
	Function apiCall(_param As NameValueCollection) As String

		Dim wc As New System.Net.WebClient With {
			.Encoding = System.Text.Encoding.UTF8
		}

		' may be needed on some machines
		Net.ServicePointManager.SecurityProtocol = CType(Net.SecurityProtocolType.Tls12, Net.SecurityProtocolType)

		_param.Item("format") = "iso8601" ' json, with dates formatted as ISO8601 string

		Dim responseBytes = wc.UploadValues("https://api.aceproject.com", "POST", _param)
		Return System.Text.Encoding.UTF8.GetString(responseBytes)

	End Function

End Class

Parameter Details
Name DataType Is Nullable Max length Domain Values Default Value Is Required
(Insert)		 Is Required
(Update)		 Is Required Description
Guid String False True Unique identifier for the authenticated user. The GUID has an expiry date and time which is managed automatically by the API.
UserId String False True Auto-generated unique identifier of a user.
ProjectId String False True Auto-generated unique identifier of a project.
ProjectManager Boolean True True or False NULL False Indicates whether the user is a project manager. If True, the user also has time sheet approval, expense approval, can open the project and fully create or modify tasks.
TimeApproval Boolean True True or False NULL False Indicates whether the user can approve time sheets. If ProjectManager is True, this parameter is ignored and True by default.
ExpenseApproval Boolean True True or False NULL False Indicates whether the user can approve expenses. If ProjectManager is True, this parameter is ignored and True by default.
CanOpenProject Boolean True True or False NULL False Indicates whether the user can open the project and see complete project content. If ProjectManager is True, this parameter is ignored and True by default.
TaskEditionLevel Integer True 1: ReadOnly
3: Limited
5: Extented
9: Full		 NULL False Indicates the type of access the user has to project's tasks.
AutoAssignment Integer True 0: Assignee, 1: Reviewer, 2: Both NULL False Indicates whether the user is automatically assignee or reviewer on new tasks .
Notify Boolean False True or False True False Indicates whether to send email notifications.
Format String False RS: RecordSet
DS: DataSet
JSON: JSON		 DS True Return Format