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
CloseClock True Stops the started time clock of the calling user.

Code Sample (Visual Basic, Dotnet Framework 4.x): 
Public Class Sample
	
	Public Sub CodeSample_closeclock()
		Dim params = New NameValueCollection From {
					{"fct", "closeclock"},
					{"guid", "###"},
					{"timesheetinoutid", ###},
					{"timetypeid", ###}
		}

		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.
TimesheetInOutId Integer False True
ProjectId Integer True NULL False Auto-generated unique identifier of a project.
TaskId Integer True NULL False Auto-generated unique identifier of a task.
TimetypeId Integer False True Auto-generated unique identifier of a time type.
InDatetime DateTime True NULL False Start datetime of the time clock.
Comments String True NULL False Any user-defined comment related to the time sheet entry (work item).
UserIP String True NULL False IP address of the computer user
Format String False RS: RecordSet
DS: DataSet
JSON: JSON		 DS True Return Format