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

// @DataContract
export class BaseRequest
{
    /** @description 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 ApiKey: string;

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

    public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}

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

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

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

    public constructor(init?: Partial<BaseSecureRequest>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponseResult
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public StatusCode: string;

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

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

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

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

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

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public IpAddress: string;

    public constructor(init?: Partial<BaseResponseResult>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponse
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public Status: BaseResponseResult;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class PrintReceiptResponse extends BaseResponse
{
    // @DataMember
    public PdfStream: string;

    // @DataMember
    public EmailSubject: string;

    // @DataMember
    public EmailBody: string;

    public constructor(init?: Partial<PrintReceiptResponse>) { super(init); (Object as any).assign(this, init); }
}

/** @description PrintReceiptRequires active-e Customer Service */
// @DataContract
export class PrintReceiptRequest extends BaseSecureRequest
{
    // @DataMember
    public Ref: string;

    /** @description 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 OutputType: string;

    /** @description 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 OutputWorkstation?: number;

    /** @description 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 OutputTo: string;

    /** @description 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 CustomerAcct?: number;

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

    public constructor(init?: Partial<PrintReceiptRequest>) { super(init); (Object as any).assign(this, init); }
}

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