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=saveclient&guid=2794e9a3-8134-4f2b-b34b-da97b8427217&clientid=NULL&clientname=NULL&clientnumber=NULL&clientaddress=NULL&clientcity=NULL&clientprovince=NULL&clientcountry=NULL&clientzipcode=NULL&clientphonenumber=NULL&clientfaxnumber=NULL&clientemail=NULL&clienturl=NULL&clientnote=NULL&clientcontactname=NULL&clientcontactphonenumber=NULL&clientcontactfaxnumber=NULL&clientcontactemail=NULL&clientcontactmobile=NULL&format=DS


Function Details
Name Guid Required Description
SaveClient True Creates a client if no ClientId is specified or updates an existing client when a valid ClientId is specified. You must be an account administrator to access this function.

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.
Clientid Integer True NULL False True Auto-generated unique identifier of a client.
ClientName String True 100 NULL True False Unique client name.
ClientNumber String True 50 NULL False User-defined client number.
ClientAddress String True NULL False Client's address.
ClientCity String True 100 NULL False Client's city.
ClientProvince String True 50 NULL False Client's province.
ClientCountry String True 100 NULL False Client's country.
ClientZipcode String True 20 NULL False Client's zip code or postal code.
ClientPhoneNumber String True 30 NULL False Client's phone number.
ClientFaxNumber String True 30 NULL False Client's fax number.
ClientEmail String True 100 NULL False Client's e-mail address.
ClientURL String True 255 NULL False Client's Web site URL.
ClientNote String True NULL False Notes related to the client.
ClientContactName String True 100 NULL False Client's contact name.
ClientContactPhoneNumber String True 30 NULL False Contact's phone number.
ClientContactFaxNumber String True 30 NULL False Contact's fax number.
ClientContactEmail String True 100 NULL False Contact's e-mail address.
ClientContactMobile String True 30 NULL False Contact's mobile number.
Format String False RS: RecordSet
DS: DataSet
JSON: JSON
DS True Return Format

.Net Code:
Public Class Sample

    Public Sub CodeSample_saveclient()
        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=saveclient")
            sb.Append(String.Format("&guid={0}", "bd88ae86-1738-4b99-8d4f-6ed2bfcc09f2"))
            sb.Append(String.Format("&clientid={0}", "NULL"))
            sb.Append(String.Format("&clientname={0}", "NULL"))
            sb.Append(String.Format("&clientnumber={0}", "NULL"))
            sb.Append(String.Format("&clientaddress={0}", "NULL"))
            sb.Append(String.Format("&clientcity={0}", "NULL"))
            sb.Append(String.Format("&clientprovince={0}", "NULL"))
            sb.Append(String.Format("&clientcountry={0}", "NULL"))
            sb.Append(String.Format("&clientzipcode={0}", "NULL"))
            sb.Append(String.Format("&clientphonenumber={0}", "NULL"))
            sb.Append(String.Format("&clientfaxnumber={0}", "NULL"))
            sb.Append(String.Format("&clientemail={0}", "NULL"))
            sb.Append(String.Format("&clienturl={0}", "NULL"))
            sb.Append(String.Format("&clientnote={0}", "NULL"))
            sb.Append(String.Format("&clientcontactname={0}", "NULL"))
            sb.Append(String.Format("&clientcontactphonenumber={0}", "NULL"))
            sb.Append(String.Format("&clientcontactfaxnumber={0}", "NULL"))
            sb.Append(String.Format("&clientcontactemail={0}", "NULL"))
            sb.Append(String.Format("&clientcontactmobile={0}", "NULL"))
            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