| GET | /api/PrintDeliveryTicket |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
/**
* PrintDeliveryTicketRequires active-e Customer Service
*/
@DataContract
public static class PrintDeliveryTicketRequest extends BaseSecureRequest
{
@DataMember
public String Ref = null;
/**
* 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 String OutputType = null;
/**
* 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 Integer OutputWorkstation = null;
/**
* 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 String OutputTo = null;
/**
* Only applies to employee logins. Customer account of the delivery ticket.
*/
@DataMember
@ApiMember(Description="Only applies to employee logins. Customer account of the delivery ticket.", Name="CustomerAcct", ParameterType="query")
public Integer CustomerAcct = null;
public String getRef() { return Ref; }
public PrintDeliveryTicketRequest setRef(String value) { this.Ref = value; return this; }
public String getOutputType() { return OutputType; }
public PrintDeliveryTicketRequest setOutputType(String value) { this.OutputType = value; return this; }
public Integer getOutputWorkstation() { return OutputWorkstation; }
public PrintDeliveryTicketRequest setOutputWorkstation(Integer value) { this.OutputWorkstation = value; return this; }
public String getOutputTo() { return OutputTo; }
public PrintDeliveryTicketRequest setOutputTo(String value) { this.OutputTo = value; return this; }
public Integer getCustomerAcct() { return CustomerAcct; }
public PrintDeliveryTicketRequest setCustomerAcct(Integer value) { this.CustomerAcct = value; return this; }
}
@DataContract
public static class BaseSecureRequest extends BaseRequest
{
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
public String Token = null;
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
public String DeviceId = null;
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
public String AppId = null;
public String getToken() { return Token; }
public BaseSecureRequest setToken(String value) { this.Token = value; return this; }
public String getDeviceId() { return DeviceId; }
public BaseSecureRequest setDeviceId(String value) { this.DeviceId = value; return this; }
public String getAppId() { return AppId; }
public BaseSecureRequest setAppId(String value) { this.AppId = value; return this; }
}
@DataContract
public static class BaseRequest
{
/**
* 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 String ApiKey = null;
@DataMember
@ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
public String OAuthToken = null;
public String getApiKey() { return ApiKey; }
public BaseRequest setApiKey(String value) { this.ApiKey = value; return this; }
public String getOAuthToken() { return OAuthToken; }
public BaseRequest setOAuthToken(String value) { this.OAuthToken = value; return this; }
}
@DataContract
public static class PrintDeliveryTicketResponse extends BaseResponse
{
@DataMember
public String PdfStream = null;
@DataMember
public String EmailSubject = null;
@DataMember
public String EmailBody = null;
public String getPdfStream() { return PdfStream; }
public PrintDeliveryTicketResponse setPdfStream(String value) { this.PdfStream = value; return this; }
public String getEmailSubject() { return EmailSubject; }
public PrintDeliveryTicketResponse setEmailSubject(String value) { this.EmailSubject = value; return this; }
public String getEmailBody() { return EmailBody; }
public PrintDeliveryTicketResponse setEmailBody(String value) { this.EmailBody = value; return this; }
}
@DataContract
public static class BaseResponse
{
/**
*
*/
@DataMember
@ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
public BaseResponseResult Status = null;
public BaseResponseResult getStatus() { return Status; }
public BaseResponse setStatus(BaseResponseResult value) { this.Status = value; return this; }
}
@DataContract
public static class BaseResponseResult
{
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
public String StatusCode = null;
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
public String Login = null;
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
public String ErrorCode = null;
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
public String ErrorDisplayText = null;
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
public String ErrorMessage = null;
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
public String DomainName = null;
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
public String IpAddress = null;
public String getStatusCode() { return StatusCode; }
public BaseResponseResult setStatusCode(String value) { this.StatusCode = value; return this; }
public String getLogin() { return Login; }
public BaseResponseResult setLogin(String value) { this.Login = value; return this; }
public String getErrorCode() { return ErrorCode; }
public BaseResponseResult setErrorCode(String value) { this.ErrorCode = value; return this; }
public String getErrorDisplayText() { return ErrorDisplayText; }
public BaseResponseResult setErrorDisplayText(String value) { this.ErrorDisplayText = value; return this; }
public String getErrorMessage() { return ErrorMessage; }
public BaseResponseResult setErrorMessage(String value) { this.ErrorMessage = value; return this; }
public String getDomainName() { return DomainName; }
public BaseResponseResult setDomainName(String value) { this.DomainName = value; return this; }
public String getIpAddress() { return IpAddress; }
public BaseResponseResult setIpAddress(String value) { this.IpAddress = value; return this; }
}
}
Java PrintDeliveryTicketRequest DTOs
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>