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.
	

Select category

Select function

Function Details

Name	Guid Required	Description
Login	False	Authenticates a user and returns the session information to the caller.

Code Sample (Visual Basic, Dotnet Framework 4.x):

Public Class Sample
	
	Public Sub CodeSample_login()
		Dim params = New NameValueCollection From {
					{"fct", "login"},
					{"accountid", "your-account-name"},
					{"username", "your-username"},
					{"password", "your-password"}
		}

		Dim jsonText = apiCall(params)

		' https://www.newtonsoft.com/json suggested for JSON parsing to DotNet framework 4.x
		Dim jsonObj = Newtonsoft.Json.Linq.JObject.Parse(jsonText)

		Dim success = jsonObj.Item("status").ToString <> "fail"
		Dim jResults = DirectCast(jsonObj.Item("results"), Newtonsoft.Json.Linq.JArray)

		Dim guid = jResults.Item(0).Item("GUID").ToString

	End Sub
	    
	Function apiCall(_param As NameValueCollection) As String

		Dim wc As New System.Net.WebClient With {
			.Encoding = System.Text.Encoding.UTF8
		}

		' may be needed on some machines
		Net.ServicePointManager.SecurityProtocol = CType(Net.SecurityProtocolType.Tls12, Net.SecurityProtocolType)

		_param.Item("format") = "iso8601" ' json, with dates formatted as ISO8601 string

		Dim responseBytes = wc.UploadValues("https://api.aceproject.com", "POST", _param)
		Return System.Text.Encoding.UTF8.GetString(responseBytes)

	End Function

End Class

Parameter Details

Name	DataType	Is Nullable	Max length	Domain Values	Default Value	Is Required (Insert)	Is Required (Update)	Is Required	Description
AccountId	String	True	50		NULL			True	Account Identifier (sub-domain for hosted accounts)
UserName	String	True	50		NULL			True
Password	String	True	50		NULL			True
BrowserInfo	String	True			NULL			True
Language	String	True	5	en-US: English fr-CA: French	NULL			False	Language used for messages and errors returned by the API.
Format	String	False		RS: RecordSet DS: DataSet JSON: JSON	DS			True	Return Format