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 java.io.InputStream
import net.servicestack.client.*


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

    @DataMember
    open var RefNumber:String? = null

    @DataMember
    open 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")
    open 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")
    open 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")
    open 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")
    open 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")
    open var AppId:String? = null
}

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

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

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

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

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

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

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

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

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

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

    @DataMember
    open var PoNumber:String? = null

    @DataMember
    open var ReturnAuthorizationNumber:String? = null

    @DataMember
    open var Status:String? = null

    @DataMember
    open var ApprovedAmount:BigDecimal? = null

    @DataMember
    open var TotalDue:BigDecimal? = null

    @DataMember
    open var Subtotal:BigDecimal? = null

    @DataMember
    open var Tax1:BigDecimal? = null

    @DataMember
    open var Tax2:BigDecimal? = null

    @DataMember
    open var ApprovedDate:Date? = null

    @DataMember
    open var BilledDate:Date? = null

    @DataMember
    open var Contact:String? = null

    @DataMember
    open var Category:Int? = null

    @DataMember
    open var Services:ArrayList<ServiceInfo>? = null

    @DataMember
    open var CategoryDescription:String? = null

    @DataMember
    open var SubCategory:Int? = null

    @DataMember
    open var SubCategoryDescription:String? = null

    @DataMember
    open var Item:String? = null

    @DataMember
    open var ItemDescription:String? = null

    @DataMember
    open var Manufacturer:String? = null

    @DataMember
    open var Notes:String? = null

    @DataMember
    open var Timestamp:Date? = null

    @DataMember
    open var SoldToCustomerAcct:Int? = null

    @DataMember
    open var BillToCustomerAcct:Int? = null

    @DataMember
    open var Model:String? = null

    @DataMember
    open var StLoc:String? = null

    @DataMember
    open var TaxLoc:String? = null

    @DataMember
    open var RefNumber:String? = null

    @DataMember
    open var MasterNumber:String? = null

    @DataMember
    open var Invoiced:Boolean? = null

    @DataMember
    open var Deposits:ArrayList<DepositInfo>? = null

    @DataMember
    open var SoldToCustomerName:String? = null

    @DataMember
    open var BillToCustomerName:String? = null

    @DataMember
    open var ShipToName:String? = null

    @DataMember
    open var ShipToId:Long? = null
}

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

    @DataMember
    open var Parts:ArrayList<PartInfo>? = null

    @DataMember
    open var Description:String? = null

    @DataMember
    open var Quantity:BigDecimal? = null

    @DataMember
    open var Rate:BigDecimal? = null

    @DataMember
    open var Discount:BigDecimal? = null

    @DataMember
    open var Total:BigDecimal? = null

    @DataMember
    open var Time:BigDecimal? = null

    @DataMember
    open var Completed:Boolean? = null

    @DataMember
    open var CompletedDate:Date? = null

    @DataMember
    open var Technician:String? = null

    @DataMember
    open var Notes:String? = null

    @DataMember
    open var Category:Int? = null

    @DataMember
    open var CategoryDescription:String? = null

    @DataMember
    open var TimerActive:Boolean? = null

    @DataMember
    open var TimerStartTime:Date? = null
}

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

    @DataMember
    open var Quantity:BigDecimal? = null

    @DataMember
    open var Price:BigDecimal? = null

    @DataMember
    open var Discount:BigDecimal? = null

    @DataMember
    open var Total:BigDecimal? = null

    @DataMember
    open var Notes:String? = null

    @DataMember
    open var Category:Int? = null

    @DataMember
    open var CategoryDescription:String? = null

    @DataMember
    open var Sku:String? = null
}

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

    @DataMember
    open var Amount:BigDecimal? = null

    @DataMember
    open var RefNumber:String? = null
}

Kotlin ServiceTicketFullDetailsRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json

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

{"Tickets":[{"Terms":0,"PoNumber":"String","ReturnAuthorizationNumber":"String","Status":"String","ApprovedAmount":0,"TotalDue":0,"Subtotal":0,"Tax1":0,"Tax2":0,"Contact":"String","Category":0,"Services":[{"Id":0,"Parts":[{"Description":"String","Quantity":0,"Price":0,"Discount":0,"Total":0,"Notes":"String","Category":0,"CategoryDescription":"String","Sku":"String"}],"Description":"String","Quantity":0,"Rate":0,"Discount":0,"Total":0,"Time":0,"Completed":false,"Technician":"String","Notes":"String","Category":0,"CategoryDescription":"String","TimerActive":false,"TimerStartTime":"0001-01-01T00:00:00.0000000"}],"CategoryDescription":"String","SubCategory":0,"SubCategoryDescription":"String","Item":"String","ItemDescription":"String","Manufacturer":"String","Notes":"String","SoldToCustomerAcct":0,"BillToCustomerAcct":0,"Model":"String","StLoc":"String","TaxLoc":"String","RefNumber":"String","MasterNumber":"String","Invoiced":false,"Deposits":[{"OriginalAmount":0,"Amount":0,"RefNumber":"String"}],"SoldToCustomerName":"String","BillToCustomerName":"String","ShipToName":"String","ShipToId":0}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}