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
UpdateProject	True	Updates 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_updateproject()
		Dim params = New NameValueCollection From {
					{"fct", "updateproject"},
					{"guid", "###"},
					{"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.
ProjectId	Integer	False						True	Auto-generated unique identifier of a project.
ProjectNumber	String	True	50		NULL			False	Unique alpha-numeric user-defined project number.
ProjectName	String	True	50		NULL			False	Unique alpha-numeric user-defined project name.
ProjectTypeId	Integer	True			NULL			False	Auto-generated unique identifier of a project type.
ProjectDesc	String	True			NULL			False	Describes any relevant information about the project.
NextTaskNumber	Integer	True			NULL			False	Next number to use for auto-numbering tasks within the project. This number is then automatically managed upon adding new tasks.
BudgetHours	Decimal	True			NULL			False	Budgeted hours for the project.
BudgetCost	Decimal	True			NULL			False	Budgeted cost for the project. This field is ignored if cost tracking is disabled for the account.
EstimatedStartDate	Date	True			NULL			False	Estimated project start date. Date must be smaller than the EstimatedEndDate.
EstimatedEndDate	Date	True			NULL			False	Estimated project end date. Date must be greater than the EstimatedStartDate.
EstimatedProjectHours	Decimal	True		Greator or equal to 0	NULL			False	Estimated project hours (does not include estimated task hours).
EstimatedProjectExpenses	Decimal	True		Greator or equal to 0	NULL			False	Estimated project expenses (does not include estimated task expenses). This parameter is ignored if cost tracking is disabled for the account.
ActualStartDate	Date	True			NULL			False	Actual project start date. This date is user-defined and not automated by the system. Date must be smaller than the ActualEndDate.
ActualEndDate	Date	True			NULL			False	Actual project end date. This date is user-defined and not automated by the system. Date must be greater than ActualStartDate.
ProjectPriorityId	Integer	True			NULL			False	Auto-generated unique identifier of a project priority.
ProjectStatusId	Integer	True			NULL			False	Auto-generated unique identifier of a project status.
ProjectTemplate	Integer	True		0: Not a template 1: Dynamic template 2: Static template	NULL			False	Indicates if the project is a template and if it is static or dynamic.
ContactName	String	True			NULL			False	Contact's name
ContactPhone	String	True			NULL			False	Contact's phone number
ContactEmail	String	True			NULL			False	Contact's E-mail
ContactCell	String	True			NULL			False	Contact's mobile number
ContactFax	String	True			NULL			False	Contact's fax number
DefaultEstimatedTime	Decimal	True		Greator or equal to 0	NULL			False	Task's estimated hours to use as a default for new tasks.
DefaultTaskStartDate	Integer	True		1: No date 2: Today's date 3: Next day 4: Next business day 5: Project's Estimated Start Date	NULL			False	Task's estimated start date to use as a default for new tasks.
DefaultTaskEndDate	Integer	True		1: No date 2: Task's Estimated Start Date 3: Project's Estimated End Date	NULL			False	Task's estimated end date to use as a default for new tasks.
DefaultTaskActualDates	Integer	True		1: Manual 2: Automatic	NULL			False	Indicates whether task actual start and end dates are to be populated automatically (triggered by changes on the status) or manually.
ClientId	Integer	True			NULL			False	Auto-generated unique identifier of a client.
IncludeWeekends	Boolean	True		True or False	NULL			False	Indicates whether to include weekends in the working days (Monday to Friday when excluding weekends) calculation, when task dates are adjusted
IncompletesTasksSetTo	Integer	True			NULL			True
TimeStatusSetTo	Integer	True			NULL			True
ExpenseStatusSetTo	Integer	True			NULL			True
MandatoryDependency	Boolean	True		True or False	NULL			False	Indicates whether project dependencies will be mandatory by default or not.
Format	String	False		RS: RecordSet DS: DataSet JSON: JSON	DS			True	Return Format