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.
https://api.aceproject.com/?fct=getusers&guid=5e2c41d1-0b7c-4057-8b11-5950c6866a55&filteruserid=NULL&filteraccesslevel=NULL&filterusergroupid=NULL&filteraccessstatus=NULL&filterassignedprojectid=NULL&filteractive=NULL&filterusername=NULL&ispmview=False&texttosearch=NULL&sortorder=NULL&forcombo=NULL&pagenumber=NULL&rowsperpage=50&asynccall=False&asynccallid=NULL&exportdomainevaleur=NULL&exporttype=NULL&exportdelimiter=NULL&exportdecimalsymbol=NULL&exportlcid=0&exportonscreencolumnsonly=True&exportview=0&exportviewother=NULL&exportfieldstodisplay=NULL&exportremovehtmlonly=True&exportenablefilterxls=False&format=DS
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. |
FilterUserId |
String |
True |
|
|
NULL |
|
|
False |
Unique identifier of a user used to filter data within a list. |
FilterAccessLevel |
Decimal |
True |
|
1: Normal 2: Administrator |
NULL |
|
|
False |
User access level used to filter data within a list. |
FilterUserGroupId |
Integer |
True |
|
|
NULL |
|
|
False |
Unique identifier of a user group used to filter data within a list. |
FilterAccessStatus |
Decimal |
True |
|
1: Active - Access Allowed 2: Active - Acces Denied 3: Inactve - Access Denied |
NULL |
|
|
False |
User access status used to filter data within a list. |
FilterAssignedProjectId |
Integer |
True |
|
|
NULL |
|
|
False |
Project identifier of a project assigned to a user used to filter data within a list. |
FilterActive |
Boolean |
True |
|
True or False |
NULL |
|
|
False |
|
FilterUserName |
String |
True |
|
|
NULL |
|
|
True |
|
IsPmView |
Boolean |
False |
|
True or False |
False |
|
|
True |
|
TextToSearch |
String |
True |
|
|
NULL |
|
|
False |
Search list based on specified text |
SortOrder |
String |
True |
|
|
NULL |
|
|
False |
Comma separated fields used for ordering a list. |
ForCombo |
String |
True |
|
|
NULL |
|
|
False |
Indicates whether returns a simplified list to display drop-down 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 |
50 |
|
|
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. |
Asynccall |
Boolean |
False |
|
True or False |
False |
|
|
True |
|
Asynccallid |
Integer |
True |
|
|
NULL |
|
|
True |
|
ExportDomaineValeur |
String |
True |
|
|
NULL |
|
|
True |
|
ExportType |
String |
True |
|
|
NULL |
|
|
True |
|
ExportDelimiter |
String |
True |
|
|
NULL |
|
|
True |
|
ExportDecimalSymbol |
String |
True |
|
|
NULL |
|
|
True |
|
ExportLCID |
Integer |
True |
|
|
0 |
|
|
True |
|
ExportOnScreenColumnsOnly |
Boolean |
True |
|
True or False |
True |
|
|
True |
|
ExportView |
Integer |
True |
|
|
0 |
|
|
True |
|
ExportViewOther |
Integer |
True |
|
|
NULL |
|
|
True |
|
ExportFieldsToDisplay |
String |
True |
|
|
NULL |
|
|
True |
|
ExportRemoveHTMLOnly |
Boolean |
True |
|
True or False |
True |
|
|
True |
|
ExportEnableFilterXLS |
Boolean |
True |
|
True or False |
False |
|
|
True |
|
Format |
String |
False |
|
RS: RecordSet DS: DataSet JSON: JSON |
DS |
|
|
True |
Return Format |
Public Class Sample
Public Sub CodeSample_getusers()
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
sb.Append("fct=getusers")
sb.Append(String.Format("&guid={0}", "144e59f8-6cfc-4f56-9926-6780bc8b076f"))
sb.Append(String.Format("&filteruserid={0}", "NULL"))
sb.Append(String.Format("&filteraccesslevel={0}", "NULL"))
sb.Append(String.Format("&filterusergroupid={0}", "NULL"))
sb.Append(String.Format("&filteraccessstatus={0}", "NULL"))
sb.Append(String.Format("&filterassignedprojectid={0}", "NULL"))
sb.Append(String.Format("&filteractive={0}", "NULL"))
sb.Append(String.Format("&filterusername={0}", "NULL"))
sb.Append(String.Format("&ispmview={0}", False))
sb.Append(String.Format("&texttosearch={0}", "NULL"))
sb.Append(String.Format("&sortorder={0}", "NULL"))
sb.Append(String.Format("&forcombo={0}", "NULL"))
sb.Append(String.Format("&pagenumber={0}", "NULL"))
sb.Append(String.Format("&rowsperpage={0}", 50))
sb.Append(String.Format("&asynccall={0}", False))
sb.Append(String.Format("&asynccallid={0}", "NULL"))
sb.Append(String.Format("&exportdomainevaleur={0}", "NULL"))
sb.Append(String.Format("&exporttype={0}", "NULL"))
sb.Append(String.Format("&exportdelimiter={0}", "NULL"))
sb.Append(String.Format("&exportdecimalsymbol={0}", "NULL"))
sb.Append(String.Format("&exportlcid={0}", 0))
sb.Append(String.Format("&exportonscreencolumnsonly={0}", True))
sb.Append(String.Format("&exportview={0}", 0))
sb.Append(String.Format("&exportviewother={0}", "NULL"))
sb.Append(String.Format("&exportfieldstodisplay={0}", "NULL"))
sb.Append(String.Format("&exportremovehtmlonly={0}", True))
sb.Append(String.Format("&exportenablefilterxls={0}", False))
sb.Append(String.Format("&format={0}", "DS"))
strXML = CallHttp("https://api.aceproject.com/", sb.ToString)
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