| POST | /Members/LockboxTransactions | ||
|---|---|---|---|
| POST | /Members/MemberLockboxTransactions |
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 MemberLockboxTransactions(ServiceRequestBase):
# @ApiMember(Description="The starting date for which to retrieve lockbox document transactions", ParameterType="body")
from_date: Optional[datetime.datetime] = None
"""
The starting date for which to retrieve lockbox document transactions
"""
# @ApiMember(Description="The ending date for which to retrieve lockbox document transactions", ParameterType="body")
to_date: Optional[datetime.datetime] = None
"""
The ending date for which to retrieve lockbox document transactions
"""
# @ApiMember(Description="The management company id for which to retrieve lockbox document transactions", ParameterType="body")
management_company_id: Optional[str] = None
"""
The management company id for which to retrieve lockbox document transactions
"""
# @ApiMember(Description="The association for which to retrieve lockbox document transactions", ParameterType="body")
association_id: Optional[str] = None
"""
The association for which to retrieve lockbox document transactions
"""
# @ApiMember(Description="The individual member for who to retrieve lockbox document transactions", ParameterType="body")
member_id: Optional[str] = None
"""
The individual member for who to retrieve lockbox document transactions
"""
# @ApiMember(Description="The type of lockbox document for which to retrieve.", ParameterType="body")
document_type: Optional[str] = None
"""
The type of lockbox document for which to retrieve.
"""
# @ApiMember(Description="The channel which the lockbox document came through.", ParameterType="body")
document_channel: Optional[str] = None
"""
The channel which the lockbox document came through.
"""
Python MemberLockboxTransactions DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Members/LockboxTransactions HTTP/1.1
Host: services.allianceassociationbank.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<MemberLockboxTransactions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Babel.Framework.ApiPlugins.Starlite.LockboxDocuments">
<AssociationId>String</AssociationId>
<DocumentChannel>String</DocumentChannel>
<DocumentType>String</DocumentType>
<FromDate>0001-01-01T00:00:00</FromDate>
<ManagementCompanyId>String</ManagementCompanyId>
<MemberId>String</MemberId>
<ToDate>0001-01-01T00:00:00</ToDate>
</MemberLockboxTransactions>
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>