Starlite API

<back to all web services

AccountTransactions

The following routes are available for this service:
POST/Accounts/Transactions
POST/AccountTransactions

// @DataContract
export class ServiceRequestBase implements IHasVersion
{

    public constructor(init?: Partial<ServiceRequestBase>) { (Object as any).assign(this, init); }
}

// @DataContract
export 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 IsSuccessful?: boolean;

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

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

    // @DataMember
    // @ApiMember(ExcludeInSchema=true)
    public ServiceDebugFields?: { [index: string]: string; };

    public constructor(init?: Partial<ServiceResponseBase>) { (Object as any).assign(this, init); }
}

// @DataContract
export class AccountTransactions 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 PropertyManagerID?: string;

    /**
    * 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 AccountNumbers?: number[];

    /**
    * 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 FromDate?: string;

    /**
    * 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 ToDate?: string;

    public constructor(init?: Partial<AccountTransactions>) { super(init); (Object as any).assign(this, init); }
}

TypeScript AccountTransactions DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

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

{"PropertyManagerID":"String","AccountNumbers":[0],"FromDate":"String","ToDate":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"IsSuccessful":false,"StatusCode":0,"StatusMessage":"String","ServiceDebugFields":{"ApiServiceHost":"WAB-WEBPW02","ApiServiceHostVersion":"1.0.0.0"}}