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
GetProjectAccess True Retrieves details about project user assignments.

Code Sample (Visual Basic, Dotnet Framework 4.x): 
Public Class Sample
	
	Public Sub CodeSample_getprojectaccess()
		Dim params = New NameValueCollection From {
					{"fct", "getprojectaccess"},
					{"guid", "###"},
					{"pagenumber", 1},
					{"rowsperpage", 100}
		}

		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.
ProjectId String True NULL False Auto-generated unique identifier of a project.
AssignedUserId Integer True NULL False Unique identifier of a user assigned to one or multiple projects.
FilterProjectTypeId Integer True NULL False Unique identifier of a project type to filter on.
FilterProjectPriorityId Integer True NULL False Unique identifier of a project priority to filter on.
FilterCompletedProject Boolean True True or False NULL False Indicates whether to filter on project status (completed, incomplete or all)
FilterClientId Integer True NULL False Unique identifier of a project's client to filter on.
IncludeInactiveTemplates Boolean False True or False True True Indicates whether to include inactive templates upon search.
IncludeInactiveUsers Boolean False True or False True True Indicates whether to include inactive users upon search.
TextToSearch String True NULL False Search list based on specified text
SortOrder String True NULL False Comma separated fields used for ordering a list.
PageNumber Integer True NULL or greater than 0 NULL False When the page number is not NULL, the API returns only the entries of the specified page within the list. A default rows per page is used within the API to determine pages if RowsPerPage parameter is not specified.
RowsPerPage Integer True NULL or greater than 0 NULL False When the number of rows per page is NULL, the API uses the default value in the system. This parameter is used only when PageNumber has a value.
Format String False RS: RecordSet
DS: DataSet
JSON: JSON		 DS True Return Format