Starlite API

<back to all web services

MemberLockboxTransactions

The following routes are available for this service:
POST/Members/LockboxTransactions
POST/Members/MemberLockboxTransactions
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Babel.Framework.ApiPlugins.Starlite.LockboxDocuments;
using Babel.Framework.ApiContext;

namespace Babel.Framework.ApiContext
{
    [DataContract]
    public partial class ServiceRequestBase
        : IHasVersion
    {
    }

    [DataContract]
    public partial class ServiceResponseBase
    {
        public ServiceResponseBase()
        {
            ServiceDebugFields = new Dictionary<string, string>{};
        }

        ///<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 virtual bool IsSuccessful { get; set; }

        ///<summary>
        ///The status code returned by the service
        ///</summary>
        [DataMember]
        [ApiMember(Description="The status code returned by the service")]
        public virtual int StatusCode { get; set; }

        ///<summary>
        ///The status message returned by the service
        ///</summary>
        [DataMember]
        [ApiMember(Description="The status message returned by the service")]
        public virtual string StatusMessage { get; set; }

        [DataMember]
        [ApiMember(ExcludeInSchema=true)]
        public virtual Dictionary<string, string> ServiceDebugFields { get; set; }
    }

}

namespace Babel.Framework.ApiPlugins.Starlite.LockboxDocuments
{
    public partial class MemberLockboxTransactions
        : 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 virtual DateTime? FromDate { 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")]
        public virtual DateTime? ToDate { 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")]
        public virtual string ManagementCompanyId { 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")]
        public virtual string AssociationId { 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")]
        public virtual string MemberId { 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")]
        public virtual string DocumentType { get; set; }

        ///<summary>
        ///The channel which the lockbox document came through.
        ///</summary>
        [ApiMember(Description="The channel which the lockbox document came through.", ParameterType="body")]
        public virtual string DocumentChannel { get; set; }
    }

}

C# MemberLockboxTransactions DTOs

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

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