| GET | /api/ServiceTicketFullDetails |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
/**
* ServiceTicketFullDetailsRequires active-e Service Tickets Service
*/
@DataContract
public static class ServiceTicketFullDetailsRequest extends BaseSecureRequest
{
@DataMember
public Integer Acct = null;
@DataMember
public String RefNumber = null;
@DataMember
public Date ChangedDate = null;
public Integer getAcct() { return Acct; }
public ServiceTicketFullDetailsRequest setAcct(Integer value) { this.Acct = value; return this; }
public String getRefNumber() { return RefNumber; }
public ServiceTicketFullDetailsRequest setRefNumber(String value) { this.RefNumber = value; return this; }
public Date getChangedDate() { return ChangedDate; }
public ServiceTicketFullDetailsRequest setChangedDate(Date value) { this.ChangedDate = value; return this; }
}
@DataContract
public static class BaseSecureRequest extends BaseRequest
{
/**
* The Login Token return by the Security API. Required for secured calls.
*/
@DataMember
@ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")
public String Token = null;
public String getToken() { return Token; }
public BaseSecureRequest setToken(String value) { this.Token = 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;
/**
* The OAuthToken token return by AeServices30
*/
@DataMember
@ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")
public String OAuthToken = null;
/**
* The Device ID of the Mobile Device. Not used for non-mobile devices.
*/
@DataMember
@ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")
public String DeviceId = null;
/**
* An identifier for your integration
*/
@DataMember
@ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")
public String AppId = 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; }
public String getDeviceId() { return DeviceId; }
public BaseRequest setDeviceId(String value) { this.DeviceId = value; return this; }
public String getAppId() { return AppId; }
public BaseRequest setAppId(String value) { this.AppId = value; return this; }
}
@DataContract
public static class ServiceTicketFullDetailsResponse extends BaseResponse
{
@DataMember
public ArrayList<TicketInfo> Tickets = null;
public ArrayList<TicketInfo> getTickets() { return Tickets; }
public ServiceTicketFullDetailsResponse setTickets(ArrayList<TicketInfo> value) { this.Tickets = 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; }
}
@DataContract
public static class TicketInfo
{
@DataMember
public Integer Terms = null;
@DataMember
public String PoNumber = null;
@DataMember
public String ReturnAuthorizationNumber = null;
@DataMember
public String Status = null;
@DataMember
public BigDecimal ApprovedAmount = null;
@DataMember
public BigDecimal TotalDue = null;
@DataMember
public BigDecimal Subtotal = null;
@DataMember
public BigDecimal Tax1 = null;
@DataMember
public BigDecimal Tax2 = null;
@DataMember
public Date ApprovedDate = null;
@DataMember
public Date BilledDate = null;
@DataMember
public String Contact = null;
@DataMember
public Integer Category = null;
@DataMember
public ArrayList<ServiceInfo> Services = null;
@DataMember
public String CategoryDescription = null;
@DataMember
public Integer SubCategory = null;
@DataMember
public String SubCategoryDescription = null;
@DataMember
public String Item = null;
@DataMember
public String ItemDescription = null;
@DataMember
public String Manufacturer = null;
@DataMember
public String Notes = null;
@DataMember
public Date Timestamp = null;
@DataMember
public Integer SoldToCustomerAcct = null;
@DataMember
public Integer BillToCustomerAcct = null;
@DataMember
public String Model = null;
@DataMember
public String StLoc = null;
@DataMember
public String TaxLoc = null;
@DataMember
public String RefNumber = null;
@DataMember
public String MasterNumber = null;
@DataMember
public Boolean Invoiced = null;
@DataMember
public ArrayList<DepositInfo> Deposits = null;
@DataMember
public String SoldToCustomerName = null;
@DataMember
public String BillToCustomerName = null;
@DataMember
public String ShipToName = null;
@DataMember
public Long ShipToId = null;
public Integer getTerms() { return Terms; }
public TicketInfo setTerms(Integer value) { this.Terms = value; return this; }
public String getPoNumber() { return PoNumber; }
public TicketInfo setPoNumber(String value) { this.PoNumber = value; return this; }
public String getReturnAuthorizationNumber() { return ReturnAuthorizationNumber; }
public TicketInfo setReturnAuthorizationNumber(String value) { this.ReturnAuthorizationNumber = value; return this; }
public String getStatus() { return Status; }
public TicketInfo setStatus(String value) { this.Status = value; return this; }
public BigDecimal getApprovedAmount() { return ApprovedAmount; }
public TicketInfo setApprovedAmount(BigDecimal value) { this.ApprovedAmount = value; return this; }
public BigDecimal getTotalDue() { return TotalDue; }
public TicketInfo setTotalDue(BigDecimal value) { this.TotalDue = value; return this; }
public BigDecimal getSubtotal() { return Subtotal; }
public TicketInfo setSubtotal(BigDecimal value) { this.Subtotal = value; return this; }
public BigDecimal getTax1() { return Tax1; }
public TicketInfo setTax1(BigDecimal value) { this.Tax1 = value; return this; }
public BigDecimal getTax2() { return Tax2; }
public TicketInfo setTax2(BigDecimal value) { this.Tax2 = value; return this; }
public Date getApprovedDate() { return ApprovedDate; }
public TicketInfo setApprovedDate(Date value) { this.ApprovedDate = value; return this; }
public Date getBilledDate() { return BilledDate; }
public TicketInfo setBilledDate(Date value) { this.BilledDate = value; return this; }
public String getContact() { return Contact; }
public TicketInfo setContact(String value) { this.Contact = value; return this; }
public Integer getCategory() { return Category; }
public TicketInfo setCategory(Integer value) { this.Category = value; return this; }
public ArrayList<ServiceInfo> getServices() { return Services; }
public TicketInfo setServices(ArrayList<ServiceInfo> value) { this.Services = value; return this; }
public String getCategoryDescription() { return CategoryDescription; }
public TicketInfo setCategoryDescription(String value) { this.CategoryDescription = value; return this; }
public Integer getSubCategory() { return SubCategory; }
public TicketInfo setSubCategory(Integer value) { this.SubCategory = value; return this; }
public String getSubCategoryDescription() { return SubCategoryDescription; }
public TicketInfo setSubCategoryDescription(String value) { this.SubCategoryDescription = value; return this; }
public String getItem() { return Item; }
public TicketInfo setItem(String value) { this.Item = value; return this; }
public String getItemDescription() { return ItemDescription; }
public TicketInfo setItemDescription(String value) { this.ItemDescription = value; return this; }
public String getManufacturer() { return Manufacturer; }
public TicketInfo setManufacturer(String value) { this.Manufacturer = value; return this; }
public String getNotes() { return Notes; }
public TicketInfo setNotes(String value) { this.Notes = value; return this; }
public Date getTimestamp() { return Timestamp; }
public TicketInfo setTimestamp(Date value) { this.Timestamp = value; return this; }
public Integer getSoldToCustomerAcct() { return SoldToCustomerAcct; }
public TicketInfo setSoldToCustomerAcct(Integer value) { this.SoldToCustomerAcct = value; return this; }
public Integer getBillToCustomerAcct() { return BillToCustomerAcct; }
public TicketInfo setBillToCustomerAcct(Integer value) { this.BillToCustomerAcct = value; return this; }
public String getModel() { return Model; }
public TicketInfo setModel(String value) { this.Model = value; return this; }
public String getStLoc() { return StLoc; }
public TicketInfo setStLoc(String value) { this.StLoc = value; return this; }
public String getTaxLoc() { return TaxLoc; }
public TicketInfo setTaxLoc(String value) { this.TaxLoc = value; return this; }
public String getRefNumber() { return RefNumber; }
public TicketInfo setRefNumber(String value) { this.RefNumber = value; return this; }
public String getMasterNumber() { return MasterNumber; }
public TicketInfo setMasterNumber(String value) { this.MasterNumber = value; return this; }
public Boolean isInvoiced() { return Invoiced; }
public TicketInfo setInvoiced(Boolean value) { this.Invoiced = value; return this; }
public ArrayList<DepositInfo> getDeposits() { return Deposits; }
public TicketInfo setDeposits(ArrayList<DepositInfo> value) { this.Deposits = value; return this; }
public String getSoldToCustomerName() { return SoldToCustomerName; }
public TicketInfo setSoldToCustomerName(String value) { this.SoldToCustomerName = value; return this; }
public String getBillToCustomerName() { return BillToCustomerName; }
public TicketInfo setBillToCustomerName(String value) { this.BillToCustomerName = value; return this; }
public String getShipToName() { return ShipToName; }
public TicketInfo setShipToName(String value) { this.ShipToName = value; return this; }
public Long getShipToId() { return ShipToId; }
public TicketInfo setShipToId(Long value) { this.ShipToId = value; return this; }
}
public static class ServiceInfo
{
@DataMember
public Long Id = null;
@DataMember
public ArrayList<PartInfo> Parts = null;
@DataMember
public String Description = null;
@DataMember
public BigDecimal Quantity = null;
@DataMember
public BigDecimal Rate = null;
@DataMember
public BigDecimal Discount = null;
@DataMember
public BigDecimal Total = null;
@DataMember
public BigDecimal Time = null;
@DataMember
public Boolean Completed = null;
@DataMember
public Date CompletedDate = null;
@DataMember
public String Technician = null;
@DataMember
public String Notes = null;
@DataMember
public Integer Category = null;
@DataMember
public String CategoryDescription = null;
@DataMember
public Boolean TimerActive = null;
@DataMember
public Date TimerStartTime = null;
public Long getId() { return Id; }
public ServiceInfo setId(Long value) { this.Id = value; return this; }
public ArrayList<PartInfo> getParts() { return Parts; }
public ServiceInfo setParts(ArrayList<PartInfo> value) { this.Parts = value; return this; }
public String getDescription() { return Description; }
public ServiceInfo setDescription(String value) { this.Description = value; return this; }
public BigDecimal getQuantity() { return Quantity; }
public ServiceInfo setQuantity(BigDecimal value) { this.Quantity = value; return this; }
public BigDecimal getRate() { return Rate; }
public ServiceInfo setRate(BigDecimal value) { this.Rate = value; return this; }
public BigDecimal getDiscount() { return Discount; }
public ServiceInfo setDiscount(BigDecimal value) { this.Discount = value; return this; }
public BigDecimal getTotal() { return Total; }
public ServiceInfo setTotal(BigDecimal value) { this.Total = value; return this; }
public BigDecimal getTime() { return Time; }
public ServiceInfo setTime(BigDecimal value) { this.Time = value; return this; }
public Boolean isCompleted() { return Completed; }
public ServiceInfo setCompleted(Boolean value) { this.Completed = value; return this; }
public Date getCompletedDate() { return CompletedDate; }
public ServiceInfo setCompletedDate(Date value) { this.CompletedDate = value; return this; }
public String getTechnician() { return Technician; }
public ServiceInfo setTechnician(String value) { this.Technician = value; return this; }
public String getNotes() { return Notes; }
public ServiceInfo setNotes(String value) { this.Notes = value; return this; }
public Integer getCategory() { return Category; }
public ServiceInfo setCategory(Integer value) { this.Category = value; return this; }
public String getCategoryDescription() { return CategoryDescription; }
public ServiceInfo setCategoryDescription(String value) { this.CategoryDescription = value; return this; }
public Boolean isTimerActive() { return TimerActive; }
public ServiceInfo setTimerActive(Boolean value) { this.TimerActive = value; return this; }
public Date getTimerStartTime() { return TimerStartTime; }
public ServiceInfo setTimerStartTime(Date value) { this.TimerStartTime = value; return this; }
}
public static class PartInfo
{
@DataMember
public String Description = null;
@DataMember
public BigDecimal Quantity = null;
@DataMember
public BigDecimal Price = null;
@DataMember
public BigDecimal Discount = null;
@DataMember
public BigDecimal Total = null;
@DataMember
public String Notes = null;
@DataMember
public Integer Category = null;
@DataMember
public String CategoryDescription = null;
@DataMember
public String Sku = null;
public String getDescription() { return Description; }
public PartInfo setDescription(String value) { this.Description = value; return this; }
public BigDecimal getQuantity() { return Quantity; }
public PartInfo setQuantity(BigDecimal value) { this.Quantity = value; return this; }
public BigDecimal getPrice() { return Price; }
public PartInfo setPrice(BigDecimal value) { this.Price = value; return this; }
public BigDecimal getDiscount() { return Discount; }
public PartInfo setDiscount(BigDecimal value) { this.Discount = value; return this; }
public BigDecimal getTotal() { return Total; }
public PartInfo setTotal(BigDecimal value) { this.Total = value; return this; }
public String getNotes() { return Notes; }
public PartInfo setNotes(String value) { this.Notes = value; return this; }
public Integer getCategory() { return Category; }
public PartInfo setCategory(Integer value) { this.Category = value; return this; }
public String getCategoryDescription() { return CategoryDescription; }
public PartInfo setCategoryDescription(String value) { this.CategoryDescription = value; return this; }
public String getSku() { return Sku; }
public PartInfo setSku(String value) { this.Sku = value; return this; }
}
public static class DepositInfo
{
@DataMember
public BigDecimal OriginalAmount = null;
@DataMember
public BigDecimal Amount = null;
@DataMember
public String RefNumber = null;
public BigDecimal getOriginalAmount() { return OriginalAmount; }
public DepositInfo setOriginalAmount(BigDecimal value) { this.OriginalAmount = value; return this; }
public BigDecimal getAmount() { return Amount; }
public DepositInfo setAmount(BigDecimal value) { this.Amount = value; return this; }
public String getRefNumber() { return RefNumber; }
public DepositInfo setRefNumber(String value) { this.RefNumber = value; return this; }
}
}
Java ServiceTicketFullDetailsRequest 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/ServiceTicketFullDetails HTTP/1.1 Host: active-ewebservice.biz Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ServiceTicketFullDetailsResponse 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>
<Tickets>
<TicketInfo>
<ApprovedAmount>0</ApprovedAmount>
<ApprovedDate>0001-01-01T00:00:00</ApprovedDate>
<BillToCustomerAcct>0</BillToCustomerAcct>
<BillToCustomerName>String</BillToCustomerName>
<BilledDate>0001-01-01T00:00:00</BilledDate>
<Category>0</Category>
<CategoryDescription>String</CategoryDescription>
<Contact>String</Contact>
<Deposits>
<DepositInfo>
<Amount>0</Amount>
<OriginalAmount>0</OriginalAmount>
<RefNumber>String</RefNumber>
</DepositInfo>
</Deposits>
<Invoiced>false</Invoiced>
<Item>String</Item>
<ItemDescription>String</ItemDescription>
<Manufacturer>String</Manufacturer>
<MasterNumber>String</MasterNumber>
<Model>String</Model>
<Notes>String</Notes>
<PoNumber>String</PoNumber>
<RefNumber>String</RefNumber>
<ReturnAuthorizationNumber>String</ReturnAuthorizationNumber>
<Services>
<ServiceInfo>
<Category>0</Category>
<CategoryDescription>String</CategoryDescription>
<Completed>false</Completed>
<CompletedDate>0001-01-01T00:00:00</CompletedDate>
<Description>String</Description>
<Discount>0</Discount>
<Id>0</Id>
<Notes>String</Notes>
<Parts>
<PartInfo>
<Category>0</Category>
<CategoryDescription>String</CategoryDescription>
<Description>String</Description>
<Discount>0</Discount>
<Notes>String</Notes>
<Price>0</Price>
<Quantity>0</Quantity>
<Sku>String</Sku>
<Total>0</Total>
</PartInfo>
</Parts>
<Quantity>0</Quantity>
<Rate>0</Rate>
<Technician>String</Technician>
<Time>0</Time>
<TimerActive>false</TimerActive>
<TimerStartTime>0001-01-01T00:00:00</TimerStartTime>
<Total>0</Total>
</ServiceInfo>
</Services>
<ShipToId>0</ShipToId>
<ShipToName>String</ShipToName>
<SoldToCustomerAcct>0</SoldToCustomerAcct>
<SoldToCustomerName>String</SoldToCustomerName>
<StLoc>String</StLoc>
<Status>String</Status>
<SubCategory>0</SubCategory>
<SubCategoryDescription>String</SubCategoryDescription>
<Subtotal>0</Subtotal>
<Tax1>0</Tax1>
<Tax2>0</Tax2>
<TaxLoc>String</TaxLoc>
<Terms>0</Terms>
<Timestamp>0001-01-01T00:00:00</Timestamp>
<TotalDue>0</TotalDue>
</TicketInfo>
</Tickets>
</ServiceTicketFullDetailsResponse>