Get current account info

The GetCurrentAccountInfo method can be used to get a sumamry of information about the current status of the account.

This will return an array of account properties; one such notable properties is APICallsInLast24Hours which lets you know how many API calls you have made in the last 24 hours, thus helping you stick within the API use limit.

Parameters

username	string	This is the username from your API key. It is in the format of an email address and will look similar to apiuser‑908709770324@apiconnector.com	required
password	string	This is the password from your API key.	required

Return values

The result is an array of APIAccountProperty objects, each consisting of.

Name	String	The name of the property. Current properties returned are: Name, MainMobilePhoneNumber, MainEmail, APICallsInLast24Hours and APICallsRemaining.
Type	String	The type of the property as a string, e.g. Int, String, ComplexType
Value	String	The string representation of the property value (e.g. “10”, “dmUser@test.com”).

Error responses

ERROR_APIUSAGE_EXCEEDED
ERROR_INVALID_LOGIN
ERROR_PARAMETER_INVALID
ERROR_SYSTEM_SERVICETEMPORARILYUNAVAILABLE
ERROR_UNKNOWN

Request

POST /API.asmx HTTP/1.1
Host: apiconnector.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://apiconnector.com/GetCurrentAccountInfo"

Example of use in C# .NET

public void GetAccountInfo()
        {
            const string userName = "apiuser-xxxxxxxxxxxx@apiconnector.com";
            const string password = "xxxxxxxxxxx";
            try
            {
                com.apiconnector.API api = new com.apiconnector.API();
                APIAccount info = api.GetCurrentAccountInfo(userName, password);
                if (info != null)
                {
                    foreach (APIAccountProperty prop in info.Properties)
                    {
                        Console.WriteLine("Property: {0} - {1} [{2}]", prop.Name, prop.Value, prop.Type);
                    }
                }
                else
                {
                    Console.WriteLine("No Account Info");
                }
            }
            catch (Exception e)
            {
                Console.WriteLine(e.ToString());
            }
        }

Example of use in VB.NET

Public Sub GetAccountInfo()
               Const  userName As String = "apiuser-xxxxxxxxxxxx@apiconnector.com"
               Const  password As String = "xxxxxxxxxxx"
               Try
                               Dim api As New com.apiconnector.API()
                               Dim info As APIAccount = api.GetCurrentAccountInfo(userName, password)
                               If info IsNot Nothing Then
                                               For Each prop As APIAccountProperty In info.Properties
                                                               Console.WriteLine("Property: {0} - {1} [{2}]", prop.Name, prop.Value, prop.Type)
                                               Next
                               Else
                                               Console.WriteLine("No Account Info")
                               End If
               Catch e As Exception
                               Console.WriteLine(e.ToString())
               End Try
End Sub

Sample request

POST /API.asmx HTTP/1.1
Host: api.nightly.dotmailer-internal
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://apiconnector.com/GetCurrentAccountInfo"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetCurrentAccountInfo xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
    </GetCurrentAccountInfo>
  </soap:Body>
</soap:Envelope>

Sample response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetCurrentAccountInfoResponse xmlns="http://apiconnector.com">
      <GetCurrentAccountInfoResult>
        <Id>int</Id>
        <Properties>
          <APIAccountProperty>
            <Name>string</Name>
            <Type>string</Type>
            <Value>string</Value>
          </APIAccountProperty>
          <APIAccountProperty>
            <Name>string</Name>
            <Type>string</Type>
            <Value>string</Value>
          </APIAccountProperty>
        </Properties>
      </GetCurrentAccountInfoResult>
    </GetCurrentAccountInfoResponse>
  </soap:Body>
</soap:Envelope>

Prebuilt integrations

More about API

Address books

Contacts

Campaigns

Reporting

SMS

Account

Images

Documents

Templates