Starlite API

<back to all web services

TransactionList

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

        Public Partial Class TransactionList
            Inherits ServiceRequestBase
            Public Sub New()
                AccountID = New List(Of String)
            End Sub

            '''<Summary>
            '''Customer Code Description
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="String", Description:="Customer Code Description", IsRequired:=true, Name:="CustomerCode", ParameterType:="form")>
            Public Overridable Property CustomerCode As String

            '''<Summary>
            '''Account ID Description
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="List<String>", Description:="Account ID Description", IsRequired:=true, Name:="AccountID", ParameterType:="form")>
            Public Overridable Property AccountID As List(Of String)

            '''<Summary>
            '''From Date Description
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="DateTime", Description:="From Date Description", IsRequired:=true, Name:="FromDate", ParameterType:="form")>
            Public Overridable Property FromDate As Date

            '''<Summary>
            '''To Date Description
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="DateTime", Description:="To Date Description", IsRequired:=true, Name:="ToDate", ParameterType:="form")>
            Public Overridable Property ToDate As Date
        End Class
    End Namespace
End Namespace

VB.NET TransactionList 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/TransactionsList HTTP/1.1 
Host: services.allianceassociationbank.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<TransactionList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Babel.Framework.ApiPlugins.Starlite.AccountTransactions">
  <_x003C_AccountID_x003E_k__BackingField xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </_x003C_AccountID_x003E_k__BackingField>
  <_x003C_CustomerCode_x003E_k__BackingField>String</_x003C_CustomerCode_x003E_k__BackingField>
  <_x003C_FromDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_FromDate_x003E_k__BackingField>
  <_x003C_ToDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_ToDate_x003E_k__BackingField>
</TransactionList>
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>AZW-AABWPW03</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>ApiServiceHostVersion</d2p1:Key>
      <d2p1:Value>2016.1.18.3</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </ServiceDebugFields>
  <StatusCode>0</StatusCode>
  <StatusMessage>String</StatusMessage>
</ServiceResponseBase>