| POST, GET | /api/PrintReceipt |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Ref | body | string | No | |
| OutputType | query | string | No | Can be STREAM, PRINT, or EMAIL. Defaults to STREAM |
| OutputWorkstation | query | int? | No | Only applies to OutputTypes of PRINT and EMAIL. The listening workstation to handle the request. |
| OutputTo | query | string | No | Only applies to OutputType of EMAIL. The email address to send to. |
| CustomerAcct | query | int? | No | Only applies to employee logins. Customer account of the receipt. |
| Date | query | DateTime? | No | Date of the receipt. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Token | Header | string | No | |
| DeviceId | Header | string | No | |
| AppId | Header | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | header | string | Yes | This is your AIM API Key provided by Tri-Tech |
| OAuthToken | header | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PdfStream | form | string | No | |
| EmailSubject | form | string | No | |
| EmailBody | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Status | body | BaseResponseResult | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StatusCode | body | string | No | |
| Login | body | string | No | |
| ErrorCode | body | string | No | |
| ErrorDisplayText | body | string | No | |
| ErrorMessage | body | string | No | |
| DomainName | body | string | No | |
| IpAddress | body | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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: text/jsonl
Content-Type: text/jsonl
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: text/jsonl
Content-Length: length
{"PdfStream":"String","EmailSubject":"String","EmailBody":"String","Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}