Starlite API

<back to all web services

AccountHistory

The following routes are available for this service:
POST/Accounts/AccountHistory
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    @DataContract
    public static class AccountHistory extends ServiceRequestBase
    {
        /**
        * The property manager ID (or customer code ID) that can manage the account(s) requested
        */
        @DataMember
        @ApiMember(DataType="string", Description="The property manager ID (or customer code ID) that can manage the account(s) requested")
        public String ManagementCompanyId = null;

        /**
        * The list of account numbers for which to receive transaction data
        */
        @DataMember
        @ApiMember(DataType="List<long>", Description="The list of account numbers for which to receive transaction data")
        public ArrayList<Long> AccountNumbers = null;

        /**
        * The earliest date (in short DateTime format) for which to find transactions in the specified date range
        */
        @DataMember
        @ApiMember(DataType="DateTime", Description="The earliest date (in short DateTime format) for which to find transactions in the specified date range", IsRequired=true)
        public Date FromDate = null;

        /**
        * The most recent date (in short DateTime format) for which to find transactions in the specified date range
        */
        @DataMember
        @ApiMember(DataType="DateTime", Description="The most recent date (in short DateTime format) for which to find transactions in the specified date range", IsRequired=true)
        public Date ToDate = null;

        /**
        * An array of external transaction codes for filtering the transactions in the response
        */
        @DataMember
        @ApiMember(DataType="List<string>", Description="An array of external transaction codes for filtering the transactions in the response")
        public ArrayList<Integer> TransactionCodes = null;
        
        public String getManagementCompanyId() { return ManagementCompanyId; }
        public AccountHistory setManagementCompanyId(String value) { this.ManagementCompanyId = value; return this; }
        public ArrayList<Long> getAccountNumbers() { return AccountNumbers; }
        public AccountHistory setAccountNumbers(ArrayList<Long> value) { this.AccountNumbers = value; return this; }
        public Date getFromDate() { return FromDate; }
        public AccountHistory setFromDate(Date value) { this.FromDate = value; return this; }
        public Date getToDate() { return ToDate; }
        public AccountHistory setToDate(Date value) { this.ToDate = value; return this; }
        public ArrayList<Integer> getTransactionCodes() { return TransactionCodes; }
        public AccountHistory setTransactionCodes(ArrayList<Integer> value) { this.TransactionCodes = value; return this; }
    }

    @DataContract
    public static class ServiceRequestBase implements IHasVersion
    {
        
    }

    @DataContract
    public static class ServiceResponseBase
    {
        /**
        * Identifies whether the request executed successfully, however does not indicated requested data was found
        */
        @DataMember
        @ApiMember(Description="Identifies whether the request executed successfully, however does not indicated requested data was found")
        public Boolean IsSuccessful = null;

        /**
        * The status code returned by the service
        */
        @DataMember
        @ApiMember(Description="The status code returned by the service")
        public Integer StatusCode = null;

        /**
        * The status message returned by the service
        */
        @DataMember
        @ApiMember(Description="The status message returned by the service")
        public String StatusMessage = null;

        @DataMember
        @ApiMember(ExcludeInSchema=true)
        public HashMap<String,String> ServiceDebugFields = null;
        
        public Boolean getIsSuccessful() { return IsSuccessful; }
        public ServiceResponseBase setIsSuccessful(Boolean value) { this.IsSuccessful = value; return this; }
        public Integer getStatusCode() { return StatusCode; }
        public ServiceResponseBase setStatusCode(Integer value) { this.StatusCode = value; return this; }
        public String getStatusMessage() { return StatusMessage; }
        public ServiceResponseBase setStatusMessage(String value) { this.StatusMessage = value; return this; }
        public HashMap<String,String> getServiceDebugFields() { return ServiceDebugFields; }
        public ServiceResponseBase setServiceDebugFields(HashMap<String,String> value) { this.ServiceDebugFields = value; return this; }
    }

}

Java AccountHistory DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Accounts/AccountHistory HTTP/1.1 
Host: services.allianceassociationbank.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AccountHistory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Babel.Framework.ApiPlugins.Starlite.AccountTransactions">
  <AccountNumbers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </AccountNumbers>
  <FromDate>0001-01-01T00:00:00</FromDate>
  <ManagementCompanyId>String</ManagementCompanyId>
  <ToDate>0001-01-01T00:00:00</ToDate>
  <TransactionCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </TransactionCodes>
</AccountHistory>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ServiceResponseBase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Babel.Framework.ApiContext">
  <IsSuccessful>false</IsSuccessful>
  <ServiceDebugFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>ApiServiceHost</d2p1:Key>
      <d2p1:Value>WAB-WEBPW02</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>ApiServiceHostVersion</d2p1:Key>
      <d2p1:Value>1.0.0.0</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </ServiceDebugFields>
  <StatusCode>0</StatusCode>
  <StatusMessage>String</StatusMessage>
</ServiceResponseBase>