Starlite API

<back to all web services

MemberLockboxTransactions

The following routes are available for this service:
POST/Members/LockboxTransactions
POST/Members/MemberLockboxTransactions
namespace Babel.Framework.ApiContext

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type ServiceResponseBase() = 
        ///<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")>]
        member val IsSuccessful:Boolean = new Boolean() with get,set

        ///<summary>
        ///The status code returned by the service
        ///</summary>
        [<DataMember>]
        [<ApiMember(Description="The status code returned by the service")>]
        member val StatusCode:Int32 = new Int32() with get,set

        ///<summary>
        ///The status message returned by the service
        ///</summary>
        [<DataMember>]
        [<ApiMember(Description="The status message returned by the service")>]
        member val StatusMessage:String = null with get,set

        [<DataMember>]
        [<ApiMember(ExcludeInSchema=true)>]
        member val ServiceDebugFields:Dictionary<String, String> = new Dictionary<String, String>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type ServiceRequestBase() = 
        class end

    [<AllowNullLiteral>]
    type MemberLockboxTransactions() = 
        inherit 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")>]
        member val FromDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        ///<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")>]
        member val ToDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        ///<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")>]
        member val ManagementCompanyId:String = null with get,set

        ///<summary>
        ///The association for which to retrieve lockbox document transactions
        ///</summary>
        [<ApiMember(Description="The association for which to retrieve lockbox document transactions", ParameterType="body")>]
        member val AssociationId:String = null with get,set

        ///<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")>]
        member val MemberId:String = null with get,set

        ///<summary>
        ///The type of lockbox document for which to retrieve.
        ///</summary>
        [<ApiMember(Description="The type of lockbox document for which to retrieve.", ParameterType="body")>]
        member val DocumentType:String = null with get,set

        ///<summary>
        ///The channel which the lockbox document came through.
        ///</summary>
        [<ApiMember(Description="The channel which the lockbox document came through.", ParameterType="body")>]
        member val DocumentChannel:String = null with get,set

F# MemberLockboxTransactions DTOs

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

HTTP + 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>