Starlite API

<back to all web services

MemberLockboxTransactions

The following routes are available for this service:
POST/Members/LockboxTransactions
POST/Members/MemberLockboxTransactions
import 'package:servicestack/servicestack.dart';

// @DataContract
abstract class ServiceRequestBase implements IHasVersion
{
    ServiceRequestBase();
    ServiceRequestBase.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "ServiceRequestBase";
    TypeContext? context = _ctx;
}

// @DataContract
class ServiceResponseBase implements IConvertible
{
    /**
    * 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")
    bool? IsSuccessful;

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

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

    // @DataMember
    // @ApiMember(ExcludeInSchema=true)
    Map<String,String?>? ServiceDebugFields;

    ServiceResponseBase({this.IsSuccessful,this.StatusCode,this.StatusMessage,this.ServiceDebugFields});
    ServiceResponseBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        IsSuccessful = json['IsSuccessful'];
        StatusCode = json['StatusCode'];
        StatusMessage = json['StatusMessage'];
        ServiceDebugFields = JsonConverters.toStringMap(json['ServiceDebugFields']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'IsSuccessful': IsSuccessful,
        'StatusCode': StatusCode,
        'StatusMessage': StatusMessage,
        'ServiceDebugFields': ServiceDebugFields
    };

    getTypeName() => "ServiceResponseBase";
    TypeContext? context = _ctx;
}

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

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

    /**
    * 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")
    String? ManagementCompanyId;

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

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

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

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

    MemberLockboxTransactions({this.FromDate,this.ToDate,this.ManagementCompanyId,this.AssociationId,this.MemberId,this.DocumentType,this.DocumentChannel});
    MemberLockboxTransactions.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        FromDate = JsonConverters.fromJson(json['FromDate'],'DateTime',context!);
        ToDate = JsonConverters.fromJson(json['ToDate'],'DateTime',context!);
        ManagementCompanyId = json['ManagementCompanyId'];
        AssociationId = json['AssociationId'];
        MemberId = json['MemberId'];
        DocumentType = json['DocumentType'];
        DocumentChannel = json['DocumentChannel'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'FromDate': JsonConverters.toJson(FromDate,'DateTime',context!),
        'ToDate': JsonConverters.toJson(ToDate,'DateTime',context!),
        'ManagementCompanyId': ManagementCompanyId,
        'AssociationId': AssociationId,
        'MemberId': MemberId,
        'DocumentType': DocumentType,
        'DocumentChannel': DocumentChannel
    });

    getTypeName() => "MemberLockboxTransactions";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'services.allianceassociationbank.com', types: <String, TypeInfo> {
    'ServiceRequestBase': TypeInfo(TypeOf.AbstractClass),
    'ServiceResponseBase': TypeInfo(TypeOf.Class, create:() => ServiceResponseBase()),
    'MemberLockboxTransactions': TypeInfo(TypeOf.Class, create:() => MemberLockboxTransactions()),
});

Dart 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>