| POST | /CheckImages |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open 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")
var AccountNumber:Long? = null
/**
* The check number to lookup
*/
@ApiMember(Description="The check number to lookup", IsRequired=true, ParameterType="form")
var CheckNumber:Int? = null
/**
* The amount which the check was made out for
*/
@ApiMember(Description="The amount which the check was made out for", IsRequired=true, ParameterType="form")
var CheckAmount:BigDecimal? = null
/**
* 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")
var PostDate:Date? = null
/**
* The trace number tied to the transaction containing the check
*/
@ApiMember(Description="The trace number tied to the transaction containing the check", ParameterType="form")
var TraceNumber:Long? = null
/**
* 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')")
var ImageReturnType:ImageReturnTypeEnum? = null
}
@DataContract
open class ServiceRequestBase : IHasVersion
{
}
enum class ImageReturnTypeEnum
{
Gif,
Png,
Jpg,
Tiff,
Bmp,
}
@DataContract
open class ServiceResponseBase
{
/**
* 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")
var IsSuccessful:Boolean? = null
/**
* The status code returned by the service
*/
@DataMember
@ApiMember(Description="The status code returned by the service")
var StatusCode:Int? = null
/**
* The status message returned by the service
*/
@DataMember
@ApiMember(Description="The status message returned by the service")
var StatusMessage:String? = null
@DataMember
@ApiMember(ExcludeInSchema=true)
var ServiceDebugFields:HashMap<String,String> = HashMap<String,String>()
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>