Starlite API

<back to all web services

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

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

<CheckImages xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Babel.Framework.ApiPlugins.Starlite.CheckImages">
  <AccountNumber>0</AccountNumber>
  <CheckAmount>0</CheckAmount>
  <CheckNumber>0</CheckNumber>
  <ImageReturnType>GIF</ImageReturnType>
  <PostDate>0001-01-01T00:00:00</PostDate>
  <TraceNumber>0</TraceNumber>
</CheckImages>

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>