| POST | /CheckImages |
|---|
namespace Babel.Framework.ApiContext
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<DataContract>]
[<AllowNullLiteral>]
type ServiceResponseBase() =
///<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")>]
member val IsSuccessful:Boolean = new Boolean() with get,set
///<summary>
///The status code returned by the service
///</summary>
[<DataMember>]
[<ApiMember(Description="The status code returned by the service")>]
member val StatusCode:Int32 = new Int32() with get,set
///<summary>
///The status message returned by the service
///</summary>
[<DataMember>]
[<ApiMember(Description="The status message returned by the service")>]
member val StatusMessage:String = null with get,set
[<DataMember>]
[<ApiMember(ExcludeInSchema=true)>]
member val ServiceDebugFields:Dictionary<String, String> = new Dictionary<String, String>() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type ServiceRequestBase() =
class end
type ImageReturnTypeEnum =
| GIF = 0
| PNG = 1
| JPG = 2
| TIFF = 3
| BMP = 4
[<AllowNullLiteral>]
type CheckImages() =
inherit 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")>]
member val AccountNumber:Int64 = new Int64() with get,set
///<summary>
///The check number to lookup
///</summary>
[<ApiMember(Description="The check number to lookup", IsRequired=true, ParameterType="form")>]
member val CheckNumber:Int32 = new Int32() with 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")>]
member val CheckAmount:Decimal = new Decimal() with 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")>]
member val PostDate:DateTime = new DateTime() with 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")>]
member val TraceNumber:Nullable<Int64> = new Nullable<Int64>() with 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')")>]
member val ImageReturnType:Nullable<ImageReturnTypeEnum> = new Nullable<ImageReturnTypeEnum>() with get,set
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
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"}}