Starlite API

CheckImages

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

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Babel.Framework.ApiPlugins.Starlite.CheckImages;
using Babel.Framework.ApiContext;
using Babel.Framework.Connectware.CheckImages;

namespace Babel.Framework.ApiContext
{
    [DataContract]
    public partial class ServiceRequestBase
        : IHasVersion
    {
    }

    [DataContract]
    public partial class ServiceResponseBase
    {
        public ServiceResponseBase()
        {
            ServiceDebugFields = new Dictionary<string, string>{};
        }

        ///<summary>
        ///Identifies whether the request executed successfully, however does not indicated requested data was found
        ///</summary>
        [DataMember]
        [ApiMember(Description="Identifies whether the request executed successfully, however does not indicated requested data was found")]
        public virtual bool IsSuccessful { get; set; }

        ///<summary>
        ///The status code returned by the service
        ///</summary>
        [DataMember]
        [ApiMember(Description="The status code returned by the service")]
        public virtual int StatusCode { get; set; }

        ///<summary>
        ///The status message returned by the service
        ///</summary>
        [DataMember]
        [ApiMember(Description="The status message returned by the service")]
        public virtual string StatusMessage { get; set; }

        [DataMember]
        [ApiMember(ExcludeInSchema=true)]
        public virtual Dictionary<string, string> ServiceDebugFields { get; set; }
    }

}

namespace Babel.Framework.ApiPlugins.Starlite.CheckImages
{
    public partial class CheckImages
        : ServiceRequestBase
    {
        ///<summary>
        ///The account number for which to find the associated check image
        ///</summary>
        [ApiMember(Description="The account number for which to find the associated check image", IsRequired=true, ParameterType="form")]
        public virtual long AccountNumber { get; set; }

        ///<summary>
        ///The check number to lookup
        ///</summary>
        [ApiMember(Description="The check number to lookup", IsRequired=true, ParameterType="form")]
        public virtual int CheckNumber { get; set; }

        ///<summary>
        ///The amount which the check was made out for
        ///</summary>
        [ApiMember(Description="The amount which the check was made out for", IsRequired=true, ParameterType="form")]
        public virtual decimal CheckAmount { get; set; }

        ///<summary>
        ///The date which the check posted on. Ensure format is 'mm/dd/yyyy'
        ///</summary>
        [ApiMember(Description="The date which the check posted on. Ensure format is 'mm/dd/yyyy'", IsRequired=true, ParameterType="form")]
        public virtual DateTime PostDate { get; set; }

        ///<summary>
        ///The trace number tied to the transaction containing the check
        ///</summary>
        [ApiMember(Description="The trace number tied to the transaction containing the check", ParameterType="form")]
        public virtual long? TraceNumber { get; set; }

        ///<summary>
        ///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')
        ///</summary>
        [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')")]
        public virtual ImageReturnTypeEnum? ImageReturnType { get; set; }
    }

}

namespace Babel.Framework.Connectware.CheckImages
{
    public enum ImageReturnTypeEnum
    {
        GIF,
        PNG,
        JPG,
        TIFF,
        BMP,
    }

}

C# 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"}}