Starlite API

<back to all web services

BankStatements

The following routes are available for this service:
POST/Statements/BankStatements
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ServiceRequestBase(IReturn[ServiceResponseBase], IHasVersion):
    @staticmethod
    def response_type(): return ServiceResponseBase


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ServiceResponseBase:
    # @ApiMember(Description="Identifies whether the request executed successfully, however does not indicated requested data was found")
    is_successful: Optional[bool] = None
    """
    Identifies whether the request executed successfully, however does not indicated requested data was found
    """


    # @ApiMember(Description="The status code returned by the service")
    status_code: Optional[int] = None
    """
    The status code returned by the service
    """


    # @ApiMember(Description="The status message returned by the service")
    status_message: Optional[str] = None
    """
    The status message returned by the service
    """


    # @ApiMember(ExcludeInSchema=true)
    service_debug_fields: Optional[Dict[str, str]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BankStatements(ServiceRequestBase):
    # @ApiMember(Description="The account number for the requested statement.", IsRequired=true)
    account_number: int = 0
    """
    The account number for the requested statement.
    """


    # @ApiMember(Description="The short-date format (mm-dd-yyyy) of the statement date.", IsRequired=true)
    statement_date: Optional[datetime.datetime] = None
    """
    The short-date format (mm-dd-yyyy) of the statement date.
    """

Python BankStatements DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
	}
}