| 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 .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
FromDate: 0001-01-01,
ToDate: 0001-01-01,
ManagementCompanyId: String,
AssociationId: String,
MemberId: String,
DocumentType: String,
DocumentChannel: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
IsSuccessful: False,
StatusCode: 0,
StatusMessage: String,
ServiceDebugFields:
{
ApiServiceHost: AZW-AABWPW03,
ApiServiceHostVersion: 2016.1.18.3
}
}