| 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
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CustomerCode: String,
AccountID:
[
String
],
FromDate: 0001-01-01,
ToDate: 0001-01-01
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
IsSuccessful: False,
StatusCode: 0,
StatusMessage: String,
ServiceDebugFields:
{
ApiServiceHost: AZW-AABWPW03,
ApiServiceHostVersion: 2016.1.18.3
}
}