Starlite API

<back to all web services

AccountBalance

The following routes are available for this service:
POST/CoreBanking/AccountBalance
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;
}

// @DataContract
class AccountBalance extends ServiceRequestBase implements IConvertible
{
    /**
    * The account number for which you want to retrieve a current balance for
    */
    // @DataMember
    // @ApiMember(DataType="long", Description="The account number for which you want to retrieve a current balance for", IsRequired=true)
    int? AccountNumber;

    /**
    * DEPRECATED
    */
    // @DataMember
    // @ApiMember(DataType="int", Description="DEPRECATED")
    int? AccountType;

    AccountBalance({this.AccountNumber,this.AccountType});
    AccountBalance.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        AccountNumber = json['AccountNumber'];
        AccountType = json['AccountType'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'AccountNumber': AccountNumber,
        'AccountType': AccountType
    });

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

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

Dart AccountBalance 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 /CoreBanking/AccountBalance HTTP/1.1 
Host: services.allianceassociationbank.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AccountBalance xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Babel.Framework.ApiPlugins.Starlite.AccountBalance">
  <AccountNumber>0</AccountNumber>
  <AccountType>0</AccountType>
</AccountBalance>
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>