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 Foundation
import ServiceStack

/**
* PrintReceiptRequires active-e Customer Service
*/
// @DataContract
public class PrintReceiptRequest : BaseSecureRequest
{
    // @DataMember
    public var ref:String

    /**
    * 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 var outputType:String

    /**
    * 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 var outputWorkstation:Int?

    /**
    * 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 var outputTo:String

    /**
    * 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 var customerAcct:Int?

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

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case ref
        case outputType
        case outputWorkstation
        case outputTo
        case customerAcct
        case date
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        ref = try container.decodeIfPresent(String.self, forKey: .ref)
        outputType = try container.decodeIfPresent(String.self, forKey: .outputType)
        outputWorkstation = try container.decodeIfPresent(Int.self, forKey: .outputWorkstation)
        outputTo = try container.decodeIfPresent(String.self, forKey: .outputTo)
        customerAcct = try container.decodeIfPresent(Int.self, forKey: .customerAcct)
        date = try container.decodeIfPresent(Date.self, forKey: .date)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if ref != nil { try container.encode(ref, forKey: .ref) }
        if outputType != nil { try container.encode(outputType, forKey: .outputType) }
        if outputWorkstation != nil { try container.encode(outputWorkstation, forKey: .outputWorkstation) }
        if outputTo != nil { try container.encode(outputTo, forKey: .outputTo) }
        if customerAcct != nil { try container.encode(customerAcct, forKey: .customerAcct) }
        if date != nil { try container.encode(date, forKey: .date) }
    }
}

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

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

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

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case token
        case deviceId
        case appId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        token = try container.decodeIfPresent(String.self, forKey: .token)
        deviceId = try container.decodeIfPresent(String.self, forKey: .deviceId)
        appId = try container.decodeIfPresent(String.self, forKey: .appId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if token != nil { try container.encode(token, forKey: .token) }
        if deviceId != nil { try container.encode(deviceId, forKey: .deviceId) }
        if appId != nil { try container.encode(appId, forKey: .appId) }
    }
}

// @DataContract
public class BaseRequest : Codable
{
    /**
    * 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 var apiKey:String

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    public var oAuthToken:String

    required public init(){}
}

// @DataContract
public class PrintReceiptResponse : BaseResponse
{
    // @DataMember
    public var pdfStream:String

    // @DataMember
    public var emailSubject:String

    // @DataMember
    public var emailBody:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case pdfStream
        case emailSubject
        case emailBody
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        pdfStream = try container.decodeIfPresent(String.self, forKey: .pdfStream)
        emailSubject = try container.decodeIfPresent(String.self, forKey: .emailSubject)
        emailBody = try container.decodeIfPresent(String.self, forKey: .emailBody)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if pdfStream != nil { try container.encode(pdfStream, forKey: .pdfStream) }
        if emailSubject != nil { try container.encode(emailSubject, forKey: .emailSubject) }
        if emailBody != nil { try container.encode(emailBody, forKey: .emailBody) }
    }
}

// @DataContract
public class BaseResponse : Codable
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public var status:BaseResponseResult

    required public init(){}
}

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

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

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

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

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

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

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public var ipAddress:String

    required public init(){}
}

Swift 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>