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
SaveAccount True Updates account information. You must be an account administrator to access this function.

Code Sample (Visual Basic, Dotnet Framework 4.x): 
Public Class Sample
	
	Public Sub CodeSample_saveaccount()
		Dim params = New NameValueCollection From {
					{"fct", "saveaccount"},
					{"guid", "###"},
					{"timezone", "NULL"},
					{"accountname", "NULL"},
					{"accountaddress", "NULL"},
					{"accountcity", "NULL"},
					{"accountprovince", "NULL"},
					{"accountcountry", "NULL"},
					{"accountzipcode", "NULL"},
					{"accountphonenumber", "NULL"},
					{"accountfaxnumber", "NULL"},
					{"accountwebsite", "NULL"},
					{"contactname", "NULL"},
					{"contactemail", "NULL"},
					{"contactphonenumber", "NULL"},
					{"contactfaxnumber", "NULL"},
					{"contactmobilenumber", "NULL"},
					{"lcid", "NULL"},
					{"weekmanagement", "NULL"},
					{"typicalworkday", "NULL"},
					{"timetracking", "NULL"},
					{"costtracking", "NULL"},
					{"currency", "NULL"},
					{"emailnotifsubject", "NULL"},
					{"startsoon", "NULL"},
					{"soondue", "NULL"},
					{"overdue", "NULL"},
					{"reminderfrequency", "NULL"},
					{"workingwithrecurrency", "NULL"}
		}

		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.
Timezone String True See GetTimeZonesList function. NULL True False Timezone identifier from the list of available timezones for AceProject
AccountName String True 100 NULL True False The account name is visible on the account login page.
AccountAddress String True NULL True False Account's address
AccountCity String True 100 NULL True False Account's city
AccountProvince String True 50 NULL True False Account's province
AccountCountry String True 100 NULL True False Account's country
AccountZipcode String True 20 NULL True False Account's zip code or postal code
AccountPhoneNumber String True 30 NULL True False Account's phone number
AccountFaxNumber String True 30 NULL True False Account's fax number
AccountWebSite String True 255 NULL True False Account's Web site
ContactName String True 100 NULL True False Contact's name
ContactEmail String True 100 NULL True False Contact's E-mail
ContactPhoneNumber String True 30 NULL True False Contact's phone number
ContactFaxNumber String True 30 NULL True False Contact's fax number
ContactMobileNumber String True 30 NULL True False Contact's mobile number
Lcid Integer True 1033 : m/d/yyyy 12:00:00 AM (0.0)
1041 : yyyy/mm/dd 24:00:00 (0.0)
2057 : dd/mm/yyyy 24:00:00 (0.0)
3084 : yyyy-mm-dd 24:00:00 (0,0)
4105 : yyyy-mm-dd 12:00:00 AM (0.0)
7177 : yyyy/mm/dd 24:00:00 (0,0)		 NULL True False Default account date and number format
WeekManagement Integer True 0 : Sunday to Saturday
1 : Monday to Sunday
6 : Saturday to Friday		 NULL True False Account's week management setting for time sheets. The setting can't be changed if time sheets are already created in the account.
TypicalWorkDay Decimal True Between 0 and 24 hours NULL True False Typical work day set in hours (decimal value) to use as default for all users within the account. When NULL, the typical work day value is ignored for the user workload reports.
TimeTracking Boolean True True or False NULL True False Flag which indicates if time tracking is activated and used within the account. If not, all references to time tracking will be disabled and related data columns will not be returned to the caller.
CostTracking Boolean True True or False NULL True False Flag which indicates if cost tracking is activated and used within the account. If not, all references to cost tracking will be disabled and related data columns will not be returned to the caller.
Currency String True 3 NULL True False Currency symbol used in AceProject screens when cost tracking is enabled. Parameter is ignored when CostTracking is false.
EmailNotifSubject Integer True 1 : Task # modified by user - project name
2 : Task created/modified by user: # Summary		 NULL True False Lets you choose the format for the "Subject" field of AceProject's task email notifications.
StartSoon Integer True NULL or greater or equal to 0 NULL True False Number of calendar days you wish all assigned or reviewer users to be reminded before the tasks' Estimated Start Date. If NULL, the start soon task reminders are disabled.
SoonDue Integer True NULL or greater or equal to 0 NULL True False Number of calendar days you wish all assigned or reviewer users to be reminded before the tasks' Estimated End Date. If NULL, the soon due task reminders are disabled.
OverDue Integer True NULL or greater or equal to 0 NULL True False Number of calendar days you wish all assigned or reviewer users to be reminded after the tasks' Estimated End Date. If NULL, the overdue task reminder is disabled.
ReminderFrequency Integer True 1 : One per day
2 : Only one notification		 NULL True False It is possible to send all assigned or reviewer users one email per day or one email only
LogoGUID String True 100 NULL True
CustomUserSkin Boolean True True or False NULL True
WorkingWithRecurrency Boolean True True or False NULL True False Flag which indicates if task recurrences are activated and used within the account.
StrongPassword Boolean True True or False NULL False Indicates whether the user needs to use a strong password or not.
PasswordExpiration Integer True NULL False Indicates in how many days the password will expire after its last modification. (O = Never)
Format String False RS: RecordSet
DS: DataSet
JSON: JSON		 DS True Return Format