Starlite API

<back to all web services

TransactionList

The following routes are available for this service:
POST/Accounts/TransactionsList
POST/TransactionList/
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 TransactionList(ServiceRequestBase):
    # @ApiMember(DataType="String", Description="Customer Code Description", IsRequired=true, Name="CustomerCode", ParameterType="form")
    customer_code: Optional[str] = None
    """
    Customer Code Description
    """


    # @ApiMember(DataType="List<String>", Description="Account ID Description", IsRequired=true, Name="AccountID", ParameterType="form")
    account_i_d: Optional[List[str]] = None
    """
    Account ID Description
    """


    # @ApiMember(DataType="DateTime", Description="From Date Description", IsRequired=true, Name="FromDate", ParameterType="form")
    from_date: datetime.datetime = datetime.datetime(1, 1, 1)
    """
    From Date Description
    """


    # @ApiMember(DataType="DateTime", Description="To Date Description", IsRequired=true, Name="ToDate", ParameterType="form")
    to_date: datetime.datetime = datetime.datetime(1, 1, 1)
    """
    To Date Description
    """

Python TransactionList 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 /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
	}
}