| POST | /CheckImages |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class CheckImages extends 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 Long AccountNumber = null;
/**
* The check number to lookup
*/
@ApiMember(Description="The check number to lookup", IsRequired=true, ParameterType="form")
public Integer CheckNumber = 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")
public BigDecimal CheckAmount = 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")
public Date PostDate = 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")
public Long TraceNumber = 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')")
public ImageReturnTypeEnum ImageReturnType = null;
public Long getAccountNumber() { return AccountNumber; }
public CheckImages setAccountNumber(Long value) { this.AccountNumber = value; return this; }
public Integer getCheckNumber() { return CheckNumber; }
public CheckImages setCheckNumber(Integer value) { this.CheckNumber = value; return this; }
public BigDecimal getCheckAmount() { return CheckAmount; }
public CheckImages setCheckAmount(BigDecimal value) { this.CheckAmount = value; return this; }
public Date getPostDate() { return PostDate; }
public CheckImages setPostDate(Date value) { this.PostDate = value; return this; }
public Long getTraceNumber() { return TraceNumber; }
public CheckImages setTraceNumber(Long value) { this.TraceNumber = value; return this; }
public ImageReturnTypeEnum getImageReturnType() { return ImageReturnType; }
public CheckImages setImageReturnType(ImageReturnTypeEnum value) { this.ImageReturnType = value; return this; }
}
@DataContract
public static class ServiceRequestBase implements IHasVersion
{
}
public static enum ImageReturnTypeEnum
{
Gif,
Png,
Jpg,
Tiff,
Bmp;
}
@DataContract
public static 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")
public Boolean IsSuccessful = null;
/**
* The status code returned by the service
*/
@DataMember
@ApiMember(Description="The status code returned by the service")
public Integer StatusCode = null;
/**
* The status message returned by the service
*/
@DataMember
@ApiMember(Description="The status message returned by the service")
public String StatusMessage = null;
@DataMember
@ApiMember(ExcludeInSchema=true)
public HashMap<String,String> ServiceDebugFields = null;
public Boolean getIsSuccessful() { return IsSuccessful; }
public ServiceResponseBase setIsSuccessful(Boolean value) { this.IsSuccessful = value; return this; }
public Integer getStatusCode() { return StatusCode; }
public ServiceResponseBase setStatusCode(Integer value) { this.StatusCode = value; return this; }
public String getStatusMessage() { return StatusMessage; }
public ServiceResponseBase setStatusMessage(String value) { this.StatusMessage = value; return this; }
public HashMap<String,String> getServiceDebugFields() { return ServiceDebugFields; }
public ServiceResponseBase setServiceDebugFields(HashMap<String,String> value) { this.ServiceDebugFields = value; return this; }
}
}
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"}}