Starlite API

<back to all web services

LockboxDocument

The following routes are available for this service:
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
    """

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

{"ManagementCompanyId":"String","AssociationId":"String","MemberId":"String","DocumentId":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"IsSuccessful":false,"StatusCode":0,"StatusMessage":"String","ServiceDebugFields":{"ApiServiceHost":"WAB-WEBPW02","ApiServiceHostVersion":"1.0.0.0"}}