AIM Web Services

<back to all web services

ServiceTicketFullDetailsRequest

ServiceTicketFullDetails
Requires active-e Service Tickets Service

The following routes are available for this service:
GET/api/ServiceTicketFullDetails
import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* ServiceTicketFullDetailsRequires active-e Service Tickets Service
*/
@DataContract
open class ServiceTicketFullDetailsRequest : BaseSecureRequest()
{
    @DataMember
    var Acct:Int? = null

    @DataMember
    var RefNumber:String? = null

    @DataMember
    var ChangedDate:Date? = null
}

@DataContract
open class BaseSecureRequest : 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")
    var Token:String? = null
}

@DataContract
open 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")
    var ApiKey:String? = null

    /**
    * The OAuthToken token return by AeServices30
    */
    @DataMember
    @ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")
    var OAuthToken:String? = 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")
    var DeviceId:String? = null

    /**
    * An identifier for your integration
    */
    @DataMember
    @ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")
    var AppId:String? = null
}

@DataContract
open class ServiceTicketFullDetailsResponse : BaseResponse()
{
    @DataMember
    var Tickets:ArrayList<TicketInfo> = ArrayList<TicketInfo>()
}

@DataContract
open class BaseResponse
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    var Status:BaseResponseResult? = null
}

@DataContract
open class BaseResponseResult
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    var StatusCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    var Login:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    var ErrorCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    var ErrorDisplayText:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    var ErrorMessage:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    var DomainName:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    var IpAddress:String? = null
}

@DataContract
open class TicketInfo
{
    @DataMember
    var Terms:Int? = null

    @DataMember
    var PoNumber:String? = null

    @DataMember
    var ReturnAuthorizationNumber:String? = null

    @DataMember
    var Status:String? = null

    @DataMember
    var ApprovedAmount:BigDecimal? = null

    @DataMember
    var TotalDue:BigDecimal? = null

    @DataMember
    var Subtotal:BigDecimal? = null

    @DataMember
    var Tax1:BigDecimal? = null

    @DataMember
    var Tax2:BigDecimal? = null

    @DataMember
    var ApprovedDate:Date? = null

    @DataMember
    var BilledDate:Date? = null

    @DataMember
    var Contact:String? = null

    @DataMember
    var Category:Int? = null

    @DataMember
    var Services:ArrayList<ServiceInfo> = ArrayList<ServiceInfo>()

    @DataMember
    var CategoryDescription:String? = null

    @DataMember
    var SubCategory:Int? = null

    @DataMember
    var SubCategoryDescription:String? = null

    @DataMember
    var Item:String? = null

    @DataMember
    var ItemDescription:String? = null

    @DataMember
    var Manufacturer:String? = null

    @DataMember
    var Notes:String? = null

    @DataMember
    var Timestamp:Date? = null

    @DataMember
    var SoldToCustomerAcct:Int? = null

    @DataMember
    var BillToCustomerAcct:Int? = null

    @DataMember
    var Model:String? = null

    @DataMember
    var StLoc:String? = null

    @DataMember
    var TaxLoc:String? = null

    @DataMember
    var RefNumber:String? = null

    @DataMember
    var MasterNumber:String? = null

    @DataMember
    var Invoiced:Boolean? = null

    @DataMember
    var Deposits:ArrayList<DepositInfo> = ArrayList<DepositInfo>()

    @DataMember
    var SoldToCustomerName:String? = null

    @DataMember
    var BillToCustomerName:String? = null

    @DataMember
    var ShipToName:String? = null

    @DataMember
    var ShipToId:Long? = null
}

open class ServiceInfo
{
    @DataMember
    var Id:Long? = null

    @DataMember
    var Parts:ArrayList<PartInfo> = ArrayList<PartInfo>()

    @DataMember
    var Description:String? = null

    @DataMember
    var Quantity:BigDecimal? = null

    @DataMember
    var Rate:BigDecimal? = null

    @DataMember
    var Discount:BigDecimal? = null

    @DataMember
    var Total:BigDecimal? = null

    @DataMember
    var Time:BigDecimal? = null

    @DataMember
    var Completed:Boolean? = null

    @DataMember
    var CompletedDate:Date? = null

    @DataMember
    var Technician:String? = null

    @DataMember
    var Notes:String? = null

    @DataMember
    var Category:Int? = null

    @DataMember
    var CategoryDescription:String? = null

    @DataMember
    var TimerActive:Boolean? = null

    @DataMember
    var TimerStartTime:Date? = null
}

open class PartInfo
{
    @DataMember
    var Description:String? = null

    @DataMember
    var Quantity:BigDecimal? = null

    @DataMember
    var Price:BigDecimal? = null

    @DataMember
    var Discount:BigDecimal? = null

    @DataMember
    var Total:BigDecimal? = null

    @DataMember
    var Notes:String? = null

    @DataMember
    var Category:Int? = null

    @DataMember
    var CategoryDescription:String? = null

    @DataMember
    var Sku:String? = null
}

open class DepositInfo
{
    @DataMember
    var OriginalAmount:BigDecimal? = null

    @DataMember
    var Amount:BigDecimal? = null

    @DataMember
    var RefNumber:String? = null
}

Kotlin ServiceTicketFullDetailsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + 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>