| POST, GET | /api/PrintReceipt |
|---|
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 BaseRequest:
# @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
api_key: Optional[str] = None
"""
This is your AIM API Key provided by Tri-Tech
"""
# @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
o_auth_token: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseSecureRequest(BaseRequest):
# @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
token: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
device_id: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
app_id: Optional[str] = None
"""
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseResponseResult:
# @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
status_code: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
login: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
error_code: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
error_display_text: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
error_message: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
domain_name: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
ip_address: Optional[str] = None
"""
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseResponse:
# @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
status: Optional[BaseResponseResult] = None
"""
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PrintReceiptResponse(BaseResponse):
pdf_stream: Optional[str] = None
email_subject: Optional[str] = None
email_body: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PrintReceiptRequest(BaseSecureRequest):
"""
PrintReceiptRequires active-e Customer Service
"""
ref: Optional[str] = None
# @ApiMember(Description="Can be STREAM, PRINT, or EMAIL. Defaults to STREAM", Name="OutputType", ParameterType="query")
output_type: Optional[str] = None
"""
Can be STREAM, PRINT, or EMAIL. Defaults to STREAM
"""
# @ApiMember(Description="Only applies to OutputTypes of PRINT and EMAIL. The listening workstation to handle the request.", Name="OutputWorkstation", ParameterType="query")
output_workstation: Optional[int] = None
"""
Only applies to OutputTypes of PRINT and EMAIL. The listening workstation to handle the request.
"""
# @ApiMember(Description="Only applies to OutputType of EMAIL. The email address to send to.", Name="OutputTo", ParameterType="query")
output_to: Optional[str] = None
"""
Only applies to OutputType of EMAIL. The email address to send to.
"""
# @ApiMember(Description="Only applies to employee logins. Customer account of the receipt.", Name="CustomerAcct", ParameterType="query")
customer_acct: Optional[int] = None
"""
Only applies to employee logins. Customer account of the receipt.
"""
# @ApiMember(Description="Date of the receipt.", Name="Date", ParameterType="query")
date: Optional[datetime.datetime] = None
"""
Date of the receipt.
"""
Python PrintReceiptRequest DTOs
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 /api/PrintReceipt HTTP/1.1
Host: active-ewebservice.biz
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<PrintReceiptRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
<ApiKey>String</ApiKey>
<OAuthToken>String</OAuthToken>
<AppId>String</AppId>
<DeviceId>String</DeviceId>
<Token>String</Token>
<CustomerAcct>0</CustomerAcct>
<Date>0001-01-01T00:00:00</Date>
<OutputTo>String</OutputTo>
<OutputType>String</OutputType>
<OutputWorkstation>0</OutputWorkstation>
<Ref>String</Ref>
</PrintReceiptRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<PrintReceiptResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
<Status>
<DomainName>String</DomainName>
<ErrorCode>String</ErrorCode>
<ErrorDisplayText>String</ErrorDisplayText>
<ErrorMessage>String</ErrorMessage>
<IpAddress>String</IpAddress>
<Login>String</Login>
<StatusCode>String</StatusCode>
</Status>
<EmailBody>String</EmailBody>
<EmailSubject>String</EmailSubject>
<PdfStream>String</PdfStream>
</PrintReceiptResponse>