Starlite API

<back to all web services

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

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>