Starlite API

<back to all web services

LockboxDocument

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 LockboxDocument extends ServiceRequestBase implements IConvertible
{
    /**
    * The management company that the member's association belongs to
    */
    // @ApiMember(Description="The management company that the member's association belongs to", IsRequired=true)
    String? ManagementCompanyId;

    /**
    * The association company that the member belongs to
    */
    // @ApiMember(Description="The association company that the member belongs to", IsRequired=true)
    String? AssociationId;

    /**
    * The member ID for whom to retrieve the lockbox document for
    */
    // @ApiMember(Description="The member ID for whom to retrieve the lockbox document for", IsRequired=true)
    String? MemberId;

    /**
    * The lockbox document ID identifying which document to pull
    */
    // @ApiMember(Description="The lockbox document ID identifying which document to pull", IsRequired=true)
    int? DocumentId;

    LockboxDocument({this.ManagementCompanyId,this.AssociationId,this.MemberId,this.DocumentId});
    LockboxDocument.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        ManagementCompanyId = json['ManagementCompanyId'];
        AssociationId = json['AssociationId'];
        MemberId = json['MemberId'];
        DocumentId = json['DocumentId'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'ManagementCompanyId': ManagementCompanyId,
        'AssociationId': AssociationId,
        'MemberId': MemberId,
        'DocumentId': DocumentId
    });

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

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

Dart LockboxDocument DTOs

POST /Members/LockboxDocument HTTP/1.1 
Host: services.allianceassociationbank.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<LockboxDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Babel.Framework.ApiPlugins.Starlite.LockboxDocuments">
  <AssociationId>String</AssociationId>
  <DocumentId>0</DocumentId>
  <ManagementCompanyId>String</ManagementCompanyId>
  <MemberId>String</MemberId>
</LockboxDocument>

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>WAB-WEBPW02</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>ApiServiceHostVersion</d2p1:Key>
      <d2p1:Value>1.0.0.0</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </ServiceDebugFields>
  <StatusCode>0</StatusCode>
  <StatusMessage>String</StatusMessage>
</ServiceResponseBase>