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 .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>