| POST | /CheckImages |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ServiceRequestBase(IReturn[ServiceResponseBase], IHasVersion):
@staticmethod
def response_type(): return ServiceResponseBase
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ServiceResponseBase:
# @ApiMember(Description="Identifies whether the request executed successfully, however does not indicated requested data was found")
is_successful: Optional[bool] = None
"""
Identifies whether the request executed successfully, however does not indicated requested data was found
"""
# @ApiMember(Description="The status code returned by the service")
status_code: Optional[int] = None
"""
The status code returned by the service
"""
# @ApiMember(Description="The status message returned by the service")
status_message: Optional[str] = None
"""
The status message returned by the service
"""
# @ApiMember(ExcludeInSchema=true)
service_debug_fields: Optional[Dict[str, str]] = None
class ImageReturnTypeEnum(str, Enum):
GIF = 'GIF'
PNG = 'PNG'
JPG = 'JPG'
TIFF = 'TIFF'
BMP = 'BMP'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CheckImages(ServiceRequestBase):
# @ApiMember(Description="The account number for which to find the associated check image", IsRequired=true, ParameterType="form")
account_number: int = 0
"""
The account number for which to find the associated check image
"""
# @ApiMember(Description="The check number to lookup", IsRequired=true, ParameterType="form")
check_number: int = 0
"""
The check number to lookup
"""
# @ApiMember(Description="The amount which the check was made out for", IsRequired=true, ParameterType="form")
check_amount: Decimal = decimal.Decimal(0)
"""
The amount which the check was made out for
"""
# @ApiMember(Description="The date which the check posted on. Ensure format is 'mm/dd/yyyy'", IsRequired=true, ParameterType="form")
post_date: datetime.datetime = datetime.datetime(1, 1, 1)
"""
The date which the check posted on. Ensure format is 'mm/dd/yyyy'
"""
# @ApiMember(Description="The trace number tied to the transaction containing the check", ParameterType="form")
trace_number: Optional[int] = None
"""
The trace number tied to the transaction containing the check
"""
# @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')")
image_return_type: Optional[ImageReturnTypeEnum] = None
"""
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')
"""
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"}}