| POST | /Members/LockboxDocument |
|---|
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 LockboxDocument(ServiceRequestBase):
# @ApiMember(Description="The management company that the member's association belongs to", IsRequired=true)
management_company_id: Optional[str] = None
"""
The management company that the member's association belongs to
"""
# @ApiMember(Description="The association company that the member belongs to", IsRequired=true)
association_id: Optional[str] = None
"""
The association company that the member belongs to
"""
# @ApiMember(Description="The member ID for whom to retrieve the lockbox document for", IsRequired=true)
member_id: Optional[str] = None
"""
The member ID for whom to retrieve the lockbox document for
"""
# @ApiMember(Description="The lockbox document ID identifying which document to pull", IsRequired=true)
document_id: int = 0
"""
The lockbox document ID identifying which document to pull
"""
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/LockboxDocument HTTP/1.1
Host: services.allianceassociationbank.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<LockboxDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Babel.Framework.ApiPlugins.Starlite.LockboxDocuments">
<AssociationId>String</AssociationId>
<DocumentId>0</DocumentId>
<ManagementCompanyId>String</ManagementCompanyId>
<MemberId>String</MemberId>
</LockboxDocument>
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>WAB-WEBPW02</d2p1:Value>
</d2p1:KeyValueOfstringstring>
<d2p1:KeyValueOfstringstring>
<d2p1:Key>ApiServiceHostVersion</d2p1:Key>
<d2p1:Value>1.0.0.0</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</ServiceDebugFields>
<StatusCode>0</StatusCode>
<StatusMessage>String</StatusMessage>
</ServiceResponseBase>