Starlite API

<back to all web services

MemberLockboxTransactions

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Babel.Framework.ApiPlugins.Starlite.LockboxDocuments
Imports Babel.Framework.ApiContext

Namespace Global

    Namespace Babel.Framework.ApiContext

        <DataContract>
        Public Partial Class ServiceRequestBase
            Implements IHasVersion
        End Class

        <DataContract>
        Public Partial Class ServiceResponseBase
            Public Sub New()
                ServiceDebugFields = New Dictionary(Of String, String)
            End Sub

            '''<Summary>
            '''Identifies whether the request executed successfully, however does not indicated requested data was found
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="Identifies whether the request executed successfully, however does not indicated requested data was found")>
            Public Overridable Property IsSuccessful As Boolean

            '''<Summary>
            '''The status code returned by the service
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="The status code returned by the service")>
            Public Overridable Property StatusCode As Integer

            '''<Summary>
            '''The status message returned by the service
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="The status message returned by the service")>
            Public Overridable Property StatusMessage As String

            <DataMember>
            <ApiMember(ExcludeInSchema:=true)>
            Public Overridable Property ServiceDebugFields As Dictionary(Of String, String)
        End Class
    End Namespace

    Namespace Babel.Framework.ApiPlugins.Starlite.LockboxDocuments

        Public Partial Class MemberLockboxTransactions
            Inherits ServiceRequestBase
            '''<Summary>
            '''The starting date for which to retrieve lockbox document transactions
            '''</Summary>
            <ApiMember(Description:="The starting date for which to retrieve lockbox document transactions", ParameterType:="body")>
            Public Overridable Property FromDate As Nullable(Of Date)

            '''<Summary>
            '''The ending date for which to retrieve lockbox document transactions
            '''</Summary>
            <ApiMember(Description:="The ending date for which to retrieve lockbox document transactions", ParameterType:="body")>
            Public Overridable Property ToDate As Nullable(Of Date)

            '''<Summary>
            '''The management company id for which to retrieve lockbox document transactions
            '''</Summary>
            <ApiMember(Description:="The management company id for which to retrieve lockbox document transactions", ParameterType:="body")>
            Public Overridable Property ManagementCompanyId As String

            '''<Summary>
            '''The association for which to retrieve lockbox document transactions
            '''</Summary>
            <ApiMember(Description:="The association for which to retrieve lockbox document transactions", ParameterType:="body")>
            Public Overridable Property AssociationId As String

            '''<Summary>
            '''The individual member for who to retrieve lockbox document transactions
            '''</Summary>
            <ApiMember(Description:="The individual member for who to retrieve lockbox document transactions", ParameterType:="body")>
            Public Overridable Property MemberId As String

            '''<Summary>
            '''The type of lockbox document for which to retrieve.
            '''</Summary>
            <ApiMember(Description:="The type of lockbox document for which to retrieve.", ParameterType:="body")>
            Public Overridable Property DocumentType As String

            '''<Summary>
            '''The channel which the lockbox document came through.
            '''</Summary>
            <ApiMember(Description:="The channel which the lockbox document came through.", ParameterType:="body")>
            Public Overridable Property DocumentChannel As String
        End Class
    End Namespace
End Namespace

VB.NET MemberLockboxTransactions DTOs

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>