Starlite API

AccountHistory

The following routes are available for this service:
POST	/Accounts/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

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/AccountHistory HTTP/1.1 
Host: services.allianceassociationbank.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ManagementCompanyId":"String","AccountNumbers":[0],"FromDate":"\/Date(-62135596800000-0000)\/","ToDate":"\/Date(-62135596800000-0000)\/","TransactionCodes":[0]}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"IsSuccessful":false,"StatusCode":0,"StatusMessage":"String","ServiceDebugFields":{"ApiServiceHost":"AZW-AABWPW03","ApiServiceHostVersion":"2016.1.18.3"}}