GET | /api/PrintDeliveryTicket |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Ref | query | 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 delivery ticket. |
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 .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/PrintDeliveryTicket HTTP/1.1 Host: active-ewebservice.biz Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <PrintDeliveryTicketResponse 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> </PrintDeliveryTicketResponse>