AIM Web Services

<back to all web services

PrintReceiptRequest

PrintReceipt
Requires active-e Customer Service

The following routes are available for this service:
POST, GET/api/PrintReceipt
import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* PrintReceiptRequires active-e Customer Service
*/
@DataContract
open class PrintReceiptRequest : BaseSecureRequest()
{
    @DataMember
    var Ref:String? = null

    /**
    * Can be STREAM, PRINT, or EMAIL. Defaults to STREAM
    */
    @DataMember
    @ApiMember(Description="Can be STREAM, PRINT, or EMAIL. Defaults to STREAM", Name="OutputType", ParameterType="query")
    var OutputType:String? = null

    /**
    * Only applies to OutputTypes of PRINT and EMAIL. The listening workstation to handle the request.
    */
    @DataMember
    @ApiMember(Description="Only applies to OutputTypes of PRINT and EMAIL. The listening workstation to handle the request.", Name="OutputWorkstation", ParameterType="query")
    var OutputWorkstation:Int? = null

    /**
    * Only applies to OutputType of EMAIL. The email address to send to.
    */
    @DataMember
    @ApiMember(Description="Only applies to OutputType of EMAIL. The email address to send to.", Name="OutputTo", ParameterType="query")
    var OutputTo:String? = null

    /**
    * Only applies to employee logins. Customer account of the receipt.
    */
    @DataMember
    @ApiMember(Description="Only applies to employee logins. Customer account of the receipt.", Name="CustomerAcct", ParameterType="query")
    var CustomerAcct:Int? = null

    /**
    * Date of the receipt.
    */
    @DataMember
    @ApiMember(Description="Date of the receipt.", Name="Date", ParameterType="query")
    var Date:Date? = null
}

@DataContract
open class BaseSecureRequest : BaseRequest()
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    var Token:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    var DeviceId:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    var AppId:String? = null
}

@DataContract
open class BaseRequest
{
    /**
    * This is your AIM API Key provided by Tri-Tech
    */
    @DataMember
    @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
    var ApiKey:String? = null

    @DataMember
    @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    var OAuthToken:String? = null
}

@DataContract
open class PrintReceiptResponse : BaseResponse()
{
    @DataMember
    var PdfStream:String? = null

    @DataMember
    var EmailSubject:String? = null

    @DataMember
    var EmailBody:String? = null
}

@DataContract
open class BaseResponse
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    var Status:BaseResponseResult? = null
}

@DataContract
open class BaseResponseResult
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    var StatusCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    var Login:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    var ErrorCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    var ErrorDisplayText:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    var ErrorMessage:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    var DomainName:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    var IpAddress:String? = null
}

Kotlin PrintReceiptRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + 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>