| POST | /Statements/BankStatements |
|---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Babel.Framework.ApiPlugins.Starlite.BankStatements
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.BankStatements
Public Partial Class BankStatements
Inherits ServiceRequestBase
'''<Summary>
'''The account number for the requested statement.
'''</Summary>
<ApiMember(Description:="The account number for the requested statement.", IsRequired:=true)>
Public Overridable Property AccountNumber As Long
'''<Summary>
'''The short-date format (mm-dd-yyyy) of the statement date.
'''</Summary>
<ApiMember(Description:="The short-date format (mm-dd-yyyy) of the statement date.", IsRequired:=true)>
Public Overridable Property StatementDate As Nullable(Of 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 /Statements/BankStatements HTTP/1.1
Host: services.allianceassociationbank.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
AccountNumber: 0,
StatementDate: 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
}
}