Starlite API

<back to all web services

CheckImages

The following routes are available for this service:
POST/CheckImages
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Babel.Framework.ApiPlugins.Starlite.CheckImages
Imports Babel.Framework.ApiContext
Imports Babel.Framework.Connectware.CheckImages

Namespace Global

    Namespace Babel.Framework.ApiContext

        <DataContract>
        Public Partial Class ServiceRequestBase
            Implements IHasVersion
        End Class

        <DataContract>
        Public Partial Class ServiceResponseBase
            Public Sub New()
                ServiceDebugFields = New Dictionary(Of String, String)
            End Sub

            '''<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 Overridable Property IsSuccessful As Boolean

            '''<Summary>
            '''The status code returned by the service
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="The status code returned by the service")>
            Public Overridable Property StatusCode As Integer

            '''<Summary>
            '''The status message returned by the service
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="The status message returned by the service")>
            Public Overridable Property StatusMessage As String

            <DataMember>
            <ApiMember(ExcludeInSchema:=true)>
            Public Overridable Property ServiceDebugFields As Dictionary(Of String, String)
        End Class
    End Namespace

    Namespace Babel.Framework.ApiPlugins.Starlite.CheckImages

        Public Partial Class CheckImages
            Inherits 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 Overridable Property AccountNumber As Long

            '''<Summary>
            '''The check number to lookup
            '''</Summary>
            <ApiMember(Description:="The check number to lookup", IsRequired:=true, ParameterType:="form")>
            Public Overridable Property CheckNumber As Integer

            '''<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 Overridable Property CheckAmount As Decimal

            '''<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 Overridable Property PostDate As Date

            '''<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 Overridable Property TraceNumber As Nullable(Of Long)

            '''<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 Overridable Property ImageReturnType As Nullable(Of ImageReturnTypeEnum)
        End Class
    End Namespace

    Namespace Babel.Framework.Connectware.CheckImages

        Public Enum ImageReturnTypeEnum
            GIF
            PNG
            JPG
            TIFF
            BMP
        End Enum
    End Namespace
End Namespace

VB.NET CheckImages 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 /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>