AIM Web Services

<back to all web services

GetServiceEstimatesRequest

GetServiceEstimates
Requires active-e Service Tickets Service

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * GetServiceEstimatesRequires active-e Service Tickets Service
    */
    @DataContract
    public static class GetServiceEstimatesRequest extends BaseSecureRequest
    {
        @DataMember
        public Boolean UseWebFormatting = null;
        
        public Boolean isUseWebFormatting() { return UseWebFormatting; }
        public GetServiceEstimatesRequest setUseWebFormatting(Boolean value) { this.UseWebFormatting = 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 GetServiceEstimatesResponse extends BaseResponse
    {
        @DataMember
        public ArrayList<ServiceEstimate> ServiceEstimates = null;
        
        public ArrayList<ServiceEstimate> getServiceEstimates() { return ServiceEstimates; }
        public GetServiceEstimatesResponse setServiceEstimates(ArrayList<ServiceEstimate> value) { this.ServiceEstimates = 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 ServiceEstimate
    {
        @DataMember
        public String TicketNumber = null;

        @DataMember
        public BigDecimal EstimatedAmount = null;

        @DataMember
        public Date DateTime = null;

        @DataMember
        public String InventoryItem = null;

        @DataMember
        public String ServiceDescription = null;

        @DataMember
        public String Notes = null;
        
        public String getTicketNumber() { return TicketNumber; }
        public ServiceEstimate setTicketNumber(String value) { this.TicketNumber = value; return this; }
        public BigDecimal getEstimatedAmount() { return EstimatedAmount; }
        public ServiceEstimate setEstimatedAmount(BigDecimal value) { this.EstimatedAmount = value; return this; }
        public Date getDateTime() { return DateTime; }
        public ServiceEstimate setDateTime(Date value) { this.DateTime = value; return this; }
        public String getInventoryItem() { return InventoryItem; }
        public ServiceEstimate setInventoryItem(String value) { this.InventoryItem = value; return this; }
        public String getServiceDescription() { return ServiceDescription; }
        public ServiceEstimate setServiceDescription(String value) { this.ServiceDescription = value; return this; }
        public String getNotes() { return Notes; }
        public ServiceEstimate setNotes(String value) { this.Notes = value; return this; }
    }

}

Java GetServiceEstimatesRequest DTOs

GET /api/GetServiceEstimates HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetServiceEstimatesResponse 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>
  <ServiceEstimates>
    <GetServiceEstimatesResponse.ServiceEstimate>
      <DateTime>0001-01-01T00:00:00</DateTime>
      <EstimatedAmount>0</EstimatedAmount>
      <InventoryItem>String</InventoryItem>
      <Notes>String</Notes>
      <ServiceDescription>String</ServiceDescription>
      <TicketNumber>String</TicketNumber>
    </GetServiceEstimatesResponse.ServiceEstimate>
  </ServiceEstimates>
</GetServiceEstimatesResponse>