Starlite API

<back to all web services

MemberLockboxTransactions

The following routes are available for this service:
POST/Members/LockboxTransactions
POST/Members/MemberLockboxTransactions

// @DataContract
export class ServiceRequestBase implements IHasVersion
{

    public constructor(init?: Partial<ServiceRequestBase>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ServiceResponseBase
{
    /**
    * Identifies whether the request executed successfully, however does not indicated requested data was found
    */
    // @DataMember
    // @ApiMember(Description="Identifies whether the request executed successfully, however does not indicated requested data was found")
    public IsSuccessful?: boolean;

    /**
    * The status code returned by the service
    */
    // @DataMember
    // @ApiMember(Description="The status code returned by the service")
    public StatusCode?: number;

    /**
    * The status message returned by the service
    */
    // @DataMember
    // @ApiMember(Description="The status message returned by the service")
    public StatusMessage?: string;

    // @DataMember
    // @ApiMember(ExcludeInSchema=true)
    public ServiceDebugFields?: { [index: string]: string; };

    public constructor(init?: Partial<ServiceResponseBase>) { (Object as any).assign(this, init); }
}

export class MemberLockboxTransactions extends ServiceRequestBase
{
    /**
    * The starting date for which to retrieve lockbox document transactions
    */
    // @ApiMember(Description="The starting date for which to retrieve lockbox document transactions", ParameterType="body")
    public FromDate?: string;

    /**
    * The ending date for which to retrieve lockbox document transactions
    */
    // @ApiMember(Description="The ending date for which to retrieve lockbox document transactions", ParameterType="body")
    public ToDate?: string;

    /**
    * The management company id for which to retrieve lockbox document transactions
    */
    // @ApiMember(Description="The management company id for which to retrieve lockbox document transactions", ParameterType="body")
    public ManagementCompanyId?: string;

    /**
    * The association for which to retrieve lockbox document transactions
    */
    // @ApiMember(Description="The association for which to retrieve lockbox document transactions", ParameterType="body")
    public AssociationId?: string;

    /**
    * The individual member for who to retrieve lockbox document transactions
    */
    // @ApiMember(Description="The individual member for who to retrieve lockbox document transactions", ParameterType="body")
    public MemberId?: string;

    /**
    * The type of lockbox document for which to retrieve.
    */
    // @ApiMember(Description="The type of lockbox document for which to retrieve.", ParameterType="body")
    public DocumentType?: string;

    /**
    * The channel which the lockbox document came through.
    */
    // @ApiMember(Description="The channel which the lockbox document came through.", ParameterType="body")
    public DocumentChannel?: string;

    public constructor(init?: Partial<MemberLockboxTransactions>) { super(init); (Object as any).assign(this, init); }
}

TypeScript 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
	}
}