Starlite API

CheckImages

The following routes are available for this service:
POST	/CheckImages

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

enum ImageReturnTypeEnum
{
    GIF,
    PNG,
    JPG,
    TIFF,
    BMP,
}

class CheckImages extends ServiceRequestBase implements IConvertible
{
    /**
    * The account number for which to find the associated check image
    */
    // @ApiMember(Description="The account number for which to find the associated check image", IsRequired=true, ParameterType="form")
    int? AccountNumber;

    /**
    * The check number to lookup
    */
    // @ApiMember(Description="The check number to lookup", IsRequired=true, ParameterType="form")
    int? CheckNumber;

    /**
    * The amount which the check was made out for
    */
    // @ApiMember(Description="The amount which the check was made out for", IsRequired=true, ParameterType="form")
    double? CheckAmount;

    /**
    * The date which the check posted on. Ensure format is 'mm/dd/yyyy'
    */
    // @ApiMember(Description="The date which the check posted on. Ensure format is 'mm/dd/yyyy'", IsRequired=true, ParameterType="form")
    DateTime? PostDate;

    /**
    * The trace number tied to the transaction containing the check
    */
    // @ApiMember(Description="The trace number tied to the transaction containing the check", ParameterType="form")
    int? TraceNumber;

    /**
    * Specify the image return type:<br/><b>GIF</b><br/><b>PNG</b><br/><b>JPG</b><br/><b>TIFF</b><br/><b>BMP</b><br/>* (Default is 'GIF')
    */
    // @ApiMember(Description="Specify the image return type:<br/><b>GIF</b><br/><b>PNG</b><br/><b>JPG</b><br/><b>TIFF</b><br/><b>BMP</b><br/>* (Default is 'GIF')")
    ImageReturnTypeEnum? ImageReturnType;

    CheckImages({this.AccountNumber,this.CheckNumber,this.CheckAmount,this.PostDate,this.TraceNumber,this.ImageReturnType});
    CheckImages.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        AccountNumber = json['AccountNumber'];
        CheckNumber = json['CheckNumber'];
        CheckAmount = JsonConverters.toDouble(json['CheckAmount']);
        PostDate = JsonConverters.fromJson(json['PostDate'],'DateTime',context!);
        TraceNumber = json['TraceNumber'];
        ImageReturnType = JsonConverters.fromJson(json['ImageReturnType'],'ImageReturnTypeEnum',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'AccountNumber': AccountNumber,
        'CheckNumber': CheckNumber,
        'CheckAmount': CheckAmount,
        'PostDate': JsonConverters.toJson(PostDate,'DateTime',context!),
        'TraceNumber': TraceNumber,
        'ImageReturnType': JsonConverters.toJson(ImageReturnType,'ImageReturnTypeEnum',context!)
    });

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

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

Dart CheckImages DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /CheckImages HTTP/1.1 
Host: services.allianceassociationbank.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"AccountNumber":0,"CheckNumber":0,"CheckAmount":0,"PostDate":"\/Date(-62135596800000-0000)\/","TraceNumber":0,"ImageReturnType":"GIF"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"IsSuccessful":false,"StatusCode":0,"StatusMessage":"String","ServiceDebugFields":{"ApiServiceHost":"AZW-AABWPW03","ApiServiceHostVersion":"2016.1.18.3"}}