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=getclients&guid=43213fc1-cd49-4094-9340-5f228fc40549&isforlist=False&clientid=NULL&texttosearch=NULL&sortorder=NULL&pagenumber=NULL&rowsperpage=NULL&format=DS

Function Details

Name	Guid Required	Description
GetClients	True	Retrieves list of clients.

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.
IsForList	Boolean	False		True or False	False			False	Indicates whether returns a simplified list to display drop-down list.
ClientId	String	True			NULL			False	Auto-generated unique identifier of a client.
TextToSearch	String	True			NULL			False	Search list based on specified text
SortOrder	String	True			NULL			False	Comma separated fields used for ordering a list.
PageNumber	Integer	True		NULL or greater than 0	NULL			False	When the page number is not NULL, the API returns only the entries of the specified page within the list. A default rows per page is used within the API to determine pages if RowsPerPage parameter is not specified.
RowsPerPage	Integer	True		NULL or greater than 0	NULL			False	When the number of rows per page is NULL, the API uses the default value in the system. This parameter is used only when PageNumber has a value.
Format	String	False		RS: RecordSet DS: DataSet JSON: JSON	DS			True	Return Format

.Net Code:

Public Class Sample

    Public Sub CodeSample_getclients()
        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=getclients")
            sb.Append(String.Format("&guid={0}", "e5f1c5e1-4227-479c-b0da-822fdeb9f7c6"))
            sb.Append(String.Format("&isforlist={0}", False))
            sb.Append(String.Format("&clientid={0}", "NULL"))
            sb.Append(String.Format("&texttosearch={0}", "NULL"))
            sb.Append(String.Format("&sortorder={0}", "NULL"))
            sb.Append(String.Format("&pagenumber={0}", "NULL"))
            sb.Append(String.Format("&rowsperpage={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