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.
Public Class Sample
Public Sub CodeSample_gettimereport()
Dim params = New NameValueCollection From {
{"fct", "gettimereport"},
{"guid", "###"}
}
Dim jsonText = apiCall(params)
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
}
Net.ServicePointManager.SecurityProtocol = CType(Net.SecurityProtocolType.Tls12, Net.SecurityProtocolType)
_param.Item("format") = "iso8601"
Dim responseBytes = wc.UploadValues("https://api.aceproject.com", "POST", _param)
Return System.Text.Encoding.UTF8.GetString(responseBytes)
End Function
End Class
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. |
View |
Integer |
True |
|
1: Daily 2: Weekly 3: Monthly |
1 |
|
|
True |
Grouping by period type |
OtherView |
Integer |
True |
|
4: Time Status 5: User Group 6: Creator Username 7: Client 8: Project Type 9: Project 10: Task Resume 11: Task Group 12: Task Type 13: Time Type |
NULL |
|
|
False |
Other grouping |
TimesheetLineId |
Integer |
True |
|
|
NULL |
|
|
False |
Auto-generated unique time sheet entry (work item) identifier. |
ProjectId |
String |
True |
|
|
NULL |
|
|
False |
Auto-generated unique identifier of a project. |
FilterMyWorkItems |
Boolean |
False |
|
True or False |
True |
|
|
True |
Returns only the calling user's time sheets (work items) if true. |
FilterTimeCreatorUserId |
String |
True |
|
|
NULL |
|
|
False |
Unique identifier of a user to filter on time sheet (work item) creator. |
FilterTimeCreatorUserGroupId |
String |
True |
|
|
NULL |
|
|
False |
Unique identifier of a user group to filter user's created time sheets (work items). |
FilterTimeTypeId |
String |
True |
|
|
NULL |
|
|
False |
Unique identifier of a time type to filter time sheets on. |
FilterTimeLevel |
Integer |
False |
|
0: All 1: Project Level Only 2: Task Level Only |
0 |
|
|
True |
Indicates whether to filter on a specific time sheet level. |
FilterTimeStatus |
String |
True |
|
0: In Progress 3: Submitted 1: Approved 2: Rejected |
NULL |
|
|
False |
Indicates whether to filter on a specific time sheet status. |
FilterDateFrom |
Date |
True |
|
|
NULL |
|
|
False |
Filter list from specified date. |
FilterDateTo |
Date |
True |
|
|
NULL |
|
|
False |
Filter list to specified date. |
FilterModifiedFrom |
DateTime |
True |
|
|
NULL |
|
|
True |
|
FilterModifiedTo |
DateTime |
True |
|
|
NULL |
|
|
True |
|
FilterProjectTypeId |
String |
True |
|
|
NULL |
|
|
False |
Unique identifier of a project type to filter on. |
FilterClientId |
String |
True |
|
|
NULL |
|
|
False |
Unique identifier of a project's associated client to filter on. |
FilterTaskId |
String |
True |
|
|
NULL |
|
|
False |
Unique identifier of a task to filter on. |
FilterTaskGroupId |
String |
True |
|
|
NULL |
|
|
False |
Unique identifier of a task group to filter on. |
FilterTaskTypeId |
String |
True |
|
|
NULL |
|
|
False |
Unique identifier of a task type to filter on. |
CountOnly |
Boolean |
False |
|
True or False |
False |
|
|
False |
Indicates whether you want only the number of rows returned by the report |
IsShowTotalsOnly |
Boolean |
False |
|
True or False |
False |
|
|
False |
Indicates whether you want only the totals and subtotals |
FieldsToDisplay |
String |
True |
|
|
NULL |
|
|
False |
Comma separated fields to display |
SortOrder |
String |
True |
|
|
NULL |
|
|
False |
Comma separated fields used for ordering a list. |
Format |
String |
False |
|
RS: RecordSet DS: DataSet JSON: JSON |
DS |
|
|
True |
Return Format |