Starlite API

<back to all web services

AccountHistory

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Babel.Framework.ApiPlugins.Starlite.AccountTransactions
Imports Babel.Framework.ApiContext

Namespace Global

    Namespace Babel.Framework.ApiContext

        <DataContract>
        Public Partial Class ServiceRequestBase
            Implements IHasVersion
        End Class

        <DataContract>
        Public Partial Class ServiceResponseBase
            Public Sub New()
                ServiceDebugFields = New Dictionary(Of String, String)
            End Sub

            '''<Summary>
            '''Identifies whether the request executed successfully, however does not indicated requested data was found
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="Identifies whether the request executed successfully, however does not indicated requested data was found")>
            Public Overridable Property IsSuccessful As Boolean

            '''<Summary>
            '''The status code returned by the service
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="The status code returned by the service")>
            Public Overridable Property StatusCode As Integer

            '''<Summary>
            '''The status message returned by the service
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="The status message returned by the service")>
            Public Overridable Property StatusMessage As String

            <DataMember>
            <ApiMember(ExcludeInSchema:=true)>
            Public Overridable Property ServiceDebugFields As Dictionary(Of String, String)
        End Class
    End Namespace

    Namespace Babel.Framework.ApiPlugins.Starlite.AccountTransactions

        <DataContract>
        Public Partial Class AccountHistory
            Inherits ServiceRequestBase
            Public Sub New()
                AccountNumbers = New List(Of Long)
                TransactionCodes = New List(Of Integer)
            End Sub

            '''<Summary>
            '''The property manager ID (or customer code ID) that can manage the account(s) requested
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="The property manager ID (or customer code ID) that can manage the account(s) requested")>
            Public Overridable Property ManagementCompanyId As String

            '''<Summary>
            '''The list of account numbers for which to receive transaction data
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="List<long>", Description:="The list of account numbers for which to receive transaction data")>
            Public Overridable Property AccountNumbers As List(Of Long)

            '''<Summary>
            '''The earliest date (in short DateTime format) for which to find transactions in the specified date range
            '''</Summary>
            <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 Overridable Property FromDate As Date

            '''<Summary>
            '''The most recent date (in short DateTime format) for which to find transactions in the specified date range
            '''</Summary>
            <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 Overridable Property ToDate As Date

            '''<Summary>
            '''An array of external transaction codes for filtering the transactions in the response
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="List<string>", Description:="An array of external transaction codes for filtering the transactions in the response")>
            Public Overridable Property TransactionCodes As List(Of Integer)
        End Class
    End Namespace
End Namespace

VB.NET AccountHistory DTOs

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>