Starlite API

<back to all web services

DailyEndingBalance

The following routes are available for this service:
POST/DailyEndingBalance
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 DailyEndingBalance(ServiceRequestBase):
    # @ApiMember(Description="The account number which to retrieve the daily balance of", IsRequired=true)
    account_number: int = 0
    """
    The account number which to retrieve the daily balance of
    """


    # @ApiMember(Description="OBSOLETE")
    account_type: Optional[int] = None
    """
    OBSOLETE
    """


    # @ApiMember(Description="The start date for which to retrieve the day-ending balance for the account")
    from_date: Optional[datetime.datetime] = None
    """
    The start date for which to retrieve the day-ending balance for the account
    """


    # @ApiMember(Description="The end date for which to retrieve the day-ending balance for the account")
    to_date: Optional[datetime.datetime] = None
    """
    The end date for which to retrieve the day-ending balance for the account
    """

Python DailyEndingBalance 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 /DailyEndingBalance HTTP/1.1 
Host: services.allianceassociationbank.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DailyEndingBalance xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Babel.Framework.ApiPlugins.Starlite.DailyBalance">
  <AccountNumber>0</AccountNumber>
  <AccountType>0</AccountType>
  <FromDate>0001-01-01T00:00:00</FromDate>
  <ToDate>0001-01-01T00:00:00</ToDate>
</DailyEndingBalance>
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-AABWPW02</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>