Starlite API

<back to all web services

AccountHistory

The following routes are available for this service:
POST/Accounts/AccountHistory
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 AccountHistory(ServiceRequestBase):
    # @ApiMember(DataType="string", Description="The property manager ID (or customer code ID) that can manage the account(s) requested")
    management_company_id: Optional[str] = None
    """
    The property manager ID (or customer code ID) that can manage the account(s) requested
    """


    # @ApiMember(DataType="List<long>", Description="The list of account numbers for which to receive transaction data")
    account_numbers: Optional[List[int]] = None
    """
    The list of account numbers for which to receive transaction data
    """


    # @ApiMember(DataType="DateTime", Description="The earliest date (in short DateTime format) for which to find transactions in the specified date range", IsRequired=true)
    from_date: datetime.datetime = datetime.datetime(1, 1, 1)
    """
    The earliest date (in short DateTime format) for which to find transactions in the specified date range
    """


    # @ApiMember(DataType="DateTime", Description="The most recent date (in short DateTime format) for which to find transactions in the specified date range", IsRequired=true)
    to_date: datetime.datetime = datetime.datetime(1, 1, 1)
    """
    The most recent date (in short DateTime format) for which to find transactions in the specified date range
    """


    # @ApiMember(DataType="List<string>", Description="An array of external transaction codes for filtering the transactions in the response")
    transaction_codes: Optional[List[int]] = None
    """
    An array of external transaction codes for filtering the transactions in the response
    """

Python AccountHistory DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Accounts/AccountHistory HTTP/1.1 
Host: services.allianceassociationbank.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ManagementCompanyId":"String","AccountNumbers":[0],"FromDate":"\/Date(-62135596800000-0000)\/","ToDate":"\/Date(-62135596800000-0000)\/","TransactionCodes":[0]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"IsSuccessful":false,"StatusCode":0,"StatusMessage":"String","ServiceDebugFields":{"ApiServiceHost":"AZW-AABWPW03","ApiServiceHostVersion":"2016.1.18.3"}}