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.
Selecting a category  

Selecting a function  

HTTP GET:

https://api.aceproject.com/?fct=gettaskstatuses&guid=3fc52c8c-ca78-424a-9bcc-205f96c79ecb&portfolioid=NULL&projectid=NULL&taskid=NULL&taskstatusid=NULL&filterwaiting=True&filterinprogress=True&filtercompleted=True&format=DS


Function Details
Name Guid Required Description
GetTaskStatuses True Retrieves list of task statuses.

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.
PortfolioId Integer True NULL True
ProjectId Integer True NULL True Auto-generated unique identifier of a project.
TaskId String True NULL False Auto-generated unique identifier of a task.
TaskStatusId Integer True NULL False Auto-generated unique identifier of a task status.
FilterWaiting Boolean False True or False True False Indicates whether to filter based on the waiting task status type.
FilterInProgress Boolean False True or False True False Indicates whether to filter based on the in progress task status type.
FilterCompleted Boolean False True or False True False Indicates whether to filter based on the completed task status type.
Format String False RS: RecordSet
DS: DataSet
JSON: JSON		 DS True Return Format

.Net Code: 
Public Class Sample

    Public Sub CodeSample_gettaskstatuses()
        Dim strXML As String = String.Empty

        Dim dsOutput As DataSet = Nothing
        Dim guid As String = String.Empty
        Dim sb As New System.Text.StringBuilder
        Try
            sb = New System.Text.StringBuilder
            'Building API QueryString
            sb.Append("fct=gettaskstatuses")
            sb.Append(String.Format("&guid={0}", "bd6ed83d-f0bf-425a-80a1-49216a0080b2"))
            sb.Append(String.Format("&portfolioid={0}", "NULL"))
            sb.Append(String.Format("&projectid={0}", "NULL"))
            sb.Append(String.Format("&taskid={0}", "NULL"))
            sb.Append(String.Format("&taskstatusid={0}", "NULL"))
            sb.Append(String.Format("&filterwaiting={0}", True))
            sb.Append(String.Format("&filterinprogress={0}", True))
            sb.Append(String.Format("&filtercompleted={0}", True))
            sb.Append(String.Format("&format={0}", "DS"))

            'Calling API
            strXML = CallHttp("https://api.aceproject.com/", sb.ToString)
            'Retreive Output structure generate by API
            dsOutput = Deserialize(Of DataSet)(strXML)
            If dsOutput IsNot Nothing AndAlso dsOutput.Tables.Count > 0 Then
                If dsOutput.Tables.Contains("dtAPIErrors") Then
                    Throw New Exception(String.Format("{0}: {1}", _
                                                      dsOutput.Tables(0).Rows(0).Item("ErrorNumber").ToString, _
                                                      dsOutput.Tables(0).Rows(0).Item("ErrorDescription").ToString))
                End If
            End If
        Catch ex As Exception
            Throw
        Finally
            If sb IsNot Nothing Then sb = Nothing
            If dsOutput IsNot Nothing Then
                dsOutput.Dispose()
                dsOutput = Nothing
            End If
        End Try
    End Sub

    Private Shared Function CallHttp( ByVal url As String, _ 
                                      ByVal params As String) As String
        Dim loHttp As System.Net.HttpWebRequest
        loHttp = CType(System.Net.WebRequest.Create(url), System.Net.HttpWebRequest)
        loHttp.Method = "POST"
        Dim requestWriter As System.IO.StreamWriter = New System.IO.StreamWriter(loHttp.GetRequestStream())

        If Not String.IsNullOrEmpty(params) Then
            requestWriter.Write(params)
        End If
        requestWriter.Close()
        loHttp.ContentType = "application/x-www-form-urlencoded"
        loHttp.Headers.Set("Pragma", "no-cache")
        loHttp.AllowAutoRedirect = True
        loHttp.KeepAlive = True
        loHttp.Timeout = 30 * 1000

        Dim loWebResponse As System.Net.HttpWebResponse = CType(loHttp.GetResponse(), System.Net.HttpWebResponse)
        Dim enc As Encoding = System.Text.Encoding.UTF8
        Dim loResponseStream As System.IO.StreamReader = New System.IO.StreamReader(loWebResponse.GetResponseStream(), enc)
        Dim lcHtml As String = loResponseStream.ReadToEnd()

        loWebResponse.Close()
        loResponseStream.Close()

        Return lcHtml
    End Function


    Private Shared Function Deserialize(Of T)( ByVal strXML As String) As T
        Dim objet As T = Nothing
        Dim objType As Type = GetType(T)
        Try
            If Not String.IsNullOrEmpty(strXML) Then
                Dim objSerializer As New System.Xml.Serialization.XmlSerializer(objType)
                Dim objText As New System.Text.StringBuilder()
                Dim objXmlReader As New System.IO.StringReader(strXML)
                objet = DirectCast(objSerializer.Deserialize(objXmlReader), T)
                objXmlReader.Close()
            End If
            Return objet
        Catch ex As Exception
            Throw
        Finally
            If objet IsNot Nothing Then objet = Nothing
        End Try
    End Function

End Class