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.*;

public class dtos
{

    /**
    * PrintReceiptRequires active-e Customer Service
    */
    @DataContract
    public static class PrintReceiptRequest extends BaseSecureRequest
    {
        @DataMember
        public String Ref = 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")
        public String OutputType = 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")
        public Integer OutputWorkstation = 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")
        public String OutputTo = 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")
        public Integer CustomerAcct = null;

        /**
        * Date of the receipt.
        */
        @DataMember
        @ApiMember(Description="Date of the receipt.", Name="Date", ParameterType="query")
        public Date Date = null;
        
        public String getRef() { return Ref; }
        public PrintReceiptRequest setRef(String value) { this.Ref = value; return this; }
        public String getOutputType() { return OutputType; }
        public PrintReceiptRequest setOutputType(String value) { this.OutputType = value; return this; }
        public Integer getOutputWorkstation() { return OutputWorkstation; }
        public PrintReceiptRequest setOutputWorkstation(Integer value) { this.OutputWorkstation = value; return this; }
        public String getOutputTo() { return OutputTo; }
        public PrintReceiptRequest setOutputTo(String value) { this.OutputTo = value; return this; }
        public Integer getCustomerAcct() { return CustomerAcct; }
        public PrintReceiptRequest setCustomerAcct(Integer value) { this.CustomerAcct = value; return this; }
        public Date getDate() { return Date; }
        public PrintReceiptRequest setDate(Date value) { this.Date = value; return this; }
    }

    @DataContract
    public static class BaseSecureRequest extends BaseRequest
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
        public String Token = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
        public String DeviceId = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
        public String AppId = null;
        
        public String getToken() { return Token; }
        public BaseSecureRequest setToken(String value) { this.Token = value; return this; }
        public String getDeviceId() { return DeviceId; }
        public BaseSecureRequest setDeviceId(String value) { this.DeviceId = value; return this; }
        public String getAppId() { return AppId; }
        public BaseSecureRequest setAppId(String value) { this.AppId = value; return this; }
    }

    @DataContract
    public static 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")
        public String ApiKey = null;

        @DataMember
        @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
        public String OAuthToken = null;
        
        public String getApiKey() { return ApiKey; }
        public BaseRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public String getOAuthToken() { return OAuthToken; }
        public BaseRequest setOAuthToken(String value) { this.OAuthToken = value; return this; }
    }

    @DataContract
    public static class PrintReceiptResponse extends BaseResponse
    {
        @DataMember
        public String PdfStream = null;

        @DataMember
        public String EmailSubject = null;

        @DataMember
        public String EmailBody = null;
        
        public String getPdfStream() { return PdfStream; }
        public PrintReceiptResponse setPdfStream(String value) { this.PdfStream = value; return this; }
        public String getEmailSubject() { return EmailSubject; }
        public PrintReceiptResponse setEmailSubject(String value) { this.EmailSubject = value; return this; }
        public String getEmailBody() { return EmailBody; }
        public PrintReceiptResponse setEmailBody(String value) { this.EmailBody = value; return this; }
    }

    @DataContract
    public static class BaseResponse
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
        public BaseResponseResult Status = null;
        
        public BaseResponseResult getStatus() { return Status; }
        public BaseResponse setStatus(BaseResponseResult value) { this.Status = value; return this; }
    }

    @DataContract
    public static class BaseResponseResult
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
        public String StatusCode = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
        public String Login = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
        public String ErrorCode = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
        public String ErrorDisplayText = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
        public String ErrorMessage = null;

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

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
        public String IpAddress = null;
        
        public String getStatusCode() { return StatusCode; }
        public BaseResponseResult setStatusCode(String value) { this.StatusCode = value; return this; }
        public String getLogin() { return Login; }
        public BaseResponseResult setLogin(String value) { this.Login = value; return this; }
        public String getErrorCode() { return ErrorCode; }
        public BaseResponseResult setErrorCode(String value) { this.ErrorCode = value; return this; }
        public String getErrorDisplayText() { return ErrorDisplayText; }
        public BaseResponseResult setErrorDisplayText(String value) { this.ErrorDisplayText = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public BaseResponseResult setErrorMessage(String value) { this.ErrorMessage = value; return this; }
        public String getDomainName() { return DomainName; }
        public BaseResponseResult setDomainName(String value) { this.DomainName = value; return this; }
        public String getIpAddress() { return IpAddress; }
        public BaseResponseResult setIpAddress(String value) { this.IpAddress = value; return this; }
    }

}

Java PrintReceiptRequest DTOs

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

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"Ref":"String","OutputType":"String","OutputWorkstation":0,"OutputTo":"String","CustomerAcct":0,"Date":"0001-01-01T00:00:00.0000000","Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"PdfStream":"String","EmailSubject":"String","EmailBody":"String","Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}