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=assignuserproject&guid=22dc1415-fa73-4cfa-a65d-b10cfc6eb38b&userid=###&projectid=###&projectmanager=NULL&timeapproval=NULL&expenseapproval=NULL&canopenproject=NULL&taskeditionlevel=NULL&autoassignment=NULL&notify=True&format=DS


Function Details
Name Guid Required Description
AssignUserProject True Assigns a user to an existing project. You must be an administrator or the project's project manager to access this function for a specific project.

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.
UserId String False True Auto-generated unique identifier of a user.
ProjectId String False True Auto-generated unique identifier of a project.
ProjectManager Boolean True True or False NULL False Indicates whether the user is a project manager. If True, the user also has time sheet approval, expense approval, can open the project and fully create or modify tasks.
TimeApproval Boolean True True or False NULL False Indicates whether the user can approve time sheets. If ProjectManager is True, this parameter is ignored and True by default.
ExpenseApproval Boolean True True or False NULL False Indicates whether the user can approve expenses. If ProjectManager is True, this parameter is ignored and True by default.
CanOpenProject Boolean True True or False NULL False Indicates whether the user can open the project and see complete project content. If ProjectManager is True, this parameter is ignored and True by default.
TaskEditionLevel Integer True 1: ReadOnly
3: Limited
5: Extented
9: Full		 NULL False Indicates the type of access the user has to project's tasks.
AutoAssignment Integer True 0: Assignee, 1: Reviewer, 2: Both NULL False Indicates whether the user is automatically assignee or reviewer on new tasks .
Notify Boolean False True or False True False Indicates whether to send email notifications.
Format String False RS: RecordSet
DS: DataSet
JSON: JSON		 DS True Return Format

.Net Code: 
Public Class Sample

    Public Sub CodeSample_assignuserproject()
        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=assignuserproject")
            sb.Append(String.Format("&guid={0}", "04ebd4a5-62f6-42cf-8e4f-2cd62253b4b7"))
            sb.Append(String.Format("&userid={0}", "###"))
            sb.Append(String.Format("&projectid={0}", "###"))
            sb.Append(String.Format("&projectmanager={0}", "NULL"))
            sb.Append(String.Format("&timeapproval={0}", "NULL"))
            sb.Append(String.Format("&expenseapproval={0}", "NULL"))
            sb.Append(String.Format("&canopenproject={0}", "NULL"))
            sb.Append(String.Format("&taskeditionlevel={0}", "NULL"))
            sb.Append(String.Format("&autoassignment={0}", "NULL"))
            sb.Append(String.Format("&notify={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