Starlite API

<back to all web services

CheckImages

import Foundation
import ServiceStack

public class CheckImages : ServiceRequestBase
{
    /**
    * 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")
    public var accountNumber:Int?

    /**
    * The check number to lookup
    */
    // @ApiMember(Description="The check number to lookup", IsRequired=true, ParameterType="form")
    public var checkNumber:Int?

    /**
    * The amount which the check was made out for
    */
    // @ApiMember(Description="The amount which the check was made out for", IsRequired=true, ParameterType="form")
    public var checkAmount:Double?

    /**
    * 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")
    public var postDate:Date?

    /**
    * The trace number tied to the transaction containing the check
    */
    // @ApiMember(Description="The trace number tied to the transaction containing the check", ParameterType="form")
    public var traceNumber:Int?

    /**
    * 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')")
    public var imageReturnType:ImageReturnTypeEnum?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case accountNumber
        case checkNumber
        case checkAmount
        case postDate
        case traceNumber
        case imageReturnType
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        accountNumber = try container.decodeIfPresent(Int.self, forKey: .accountNumber)
        checkNumber = try container.decodeIfPresent(Int.self, forKey: .checkNumber)
        checkAmount = try container.decodeIfPresent(Double.self, forKey: .checkAmount)
        postDate = try container.decodeIfPresent(Date.self, forKey: .postDate)
        traceNumber = try container.decodeIfPresent(Int.self, forKey: .traceNumber)
        imageReturnType = try container.decodeIfPresent(ImageReturnTypeEnum.self, forKey: .imageReturnType)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if accountNumber != nil { try container.encode(accountNumber, forKey: .accountNumber) }
        if checkNumber != nil { try container.encode(checkNumber, forKey: .checkNumber) }
        if checkAmount != nil { try container.encode(checkAmount, forKey: .checkAmount) }
        if postDate != nil { try container.encode(postDate, forKey: .postDate) }
        if traceNumber != nil { try container.encode(traceNumber, forKey: .traceNumber) }
        if imageReturnType != nil { try container.encode(imageReturnType, forKey: .imageReturnType) }
    }
}

// @DataContract
public class ServiceRequestBase : IHasVersion, Codable
{
    required public init(){}
}

public enum ImageReturnTypeEnum : String, Codable
{
    case GIF
    case PNG
    case JPG
    case TIFF
    case BMP
}

// @DataContract
public class ServiceResponseBase : Codable
{
    /**
    * 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")
    public var isSuccessful:Bool?

    /**
    * The status code returned by the service
    */
    // @DataMember
    // @ApiMember(Description="The status code returned by the service")
    public var statusCode:Int?

    /**
    * The status message returned by the service
    */
    // @DataMember
    // @ApiMember(Description="The status message returned by the service")
    public var statusMessage:String?

    // @DataMember
    // @ApiMember(ExcludeInSchema=true)
    public var serviceDebugFields:[String:String] = [:]

    required public init(){}
}

Swift CheckImages DTOs

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

{
	AccountNumber: 0,
	CheckNumber: 0,
	CheckAmount: 0,
	PostDate: 0001-01-01,
	TraceNumber: 0,
	ImageReturnType: GIF
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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