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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AIM.WebService;

namespace AIM.WebService
{
    [DataContract]
    public partial class BaseRequest
    {
        ///<summary>
        ///This is your AIM API Key provided by Tri-Tech
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")]
        public virtual string ApiKey { get; set; }

        [DataMember]
        [ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")]
        public virtual string OAuthToken { get; set; }
    }

    [DataContract]
    public partial class BaseResponse
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")]
        public virtual BaseResponseResult Status { get; set; }
        [DataContract]
        public partial class BaseResponseResult
        {
            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")]
            public virtual string StatusCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")]
            public virtual string Login { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")]
            public virtual string ErrorCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")]
            public virtual string ErrorDisplayText { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")]
            public virtual string ErrorMessage { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")]
            public virtual string DomainName { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")]
            public virtual string IpAddress { get; set; }
        }

    }

    [DataContract]
    public partial class BaseSecureRequest
        : BaseRequest
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")]
        public virtual string Token { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")]
        public virtual string DeviceId { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")]
        public virtual string AppId { get; set; }
    }

    ///<summary>
    ///PrintReceiptRequires active-e Customer Service
    ///</summary>
    [DataContract]
    public partial class PrintReceiptRequest
        : BaseSecureRequest
    {
        [DataMember]
        public virtual string Ref { get; set; }

        ///<summary>
        ///Can be STREAM, PRINT, or EMAIL. Defaults to STREAM
        ///</summary>
        [DataMember]
        [ApiMember(Description="Can be STREAM, PRINT, or EMAIL. Defaults to STREAM", Name="OutputType", ParameterType="query")]
        public virtual string OutputType { get; set; }

        ///<summary>
        ///Only applies to OutputTypes of PRINT and EMAIL. The listening workstation to handle the request.
        ///</summary>
        [DataMember]
        [ApiMember(Description="Only applies to OutputTypes of PRINT and EMAIL. The listening workstation to handle the request.", Name="OutputWorkstation", ParameterType="query")]
        public virtual int? OutputWorkstation { get; set; }

        ///<summary>
        ///Only applies to OutputType of EMAIL. The email address to send to.
        ///</summary>
        [DataMember]
        [ApiMember(Description="Only applies to OutputType of EMAIL. The email address to send to.", Name="OutputTo", ParameterType="query")]
        public virtual string OutputTo { get; set; }

        ///<summary>
        ///Only applies to employee logins. Customer account of the receipt.
        ///</summary>
        [DataMember]
        [ApiMember(Description="Only applies to employee logins. Customer account of the receipt.", Name="CustomerAcct", ParameterType="query")]
        public virtual int? CustomerAcct { get; set; }

        ///<summary>
        ///Date of the receipt.
        ///</summary>
        [DataMember]
        [ApiMember(Description="Date of the receipt.", Name="Date", ParameterType="query")]
        public virtual DateTime? Date { get; set; }
    }

    [DataContract]
    public partial class PrintReceiptResponse
        : BaseResponse
    {
        [DataMember]
        public virtual string PdfStream { get; set; }

        [DataMember]
        public virtual string EmailSubject { get; set; }

        [DataMember]
        public virtual string EmailBody { get; set; }
    }

}

C# 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"}}