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
namespace AIM.WebService

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponseResult() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")>]
        member val StatusCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")>]
        member val Login:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")>]
        member val ErrorCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")>]
        member val ErrorDisplayText:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")>]
        member val ErrorMessage:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")>]
        member val DomainName:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")>]
        member val IpAddress:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponse() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")>]
        member val Status:BaseResponseResult = null with get,set

    [<AllowNullLiteral>]
    type PartInfo() = 
        [<DataMember>]
        member val Description:String = null with get,set

        [<DataMember>]
        member val Quantity:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Price:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Discount:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Total:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Notes:String = null with get,set

        [<DataMember>]
        member val Category:Int32 = new Int32() with get,set

        [<DataMember>]
        member val CategoryDescription:String = null with get,set

        [<DataMember>]
        member val Sku:String = null with get,set

    [<AllowNullLiteral>]
    type ServiceInfo() = 
        [<DataMember>]
        member val Id:Int64 = new Int64() with get,set

        [<DataMember>]
        member val Parts:ResizeArray<PartInfo> = new ResizeArray<PartInfo>() with get,set

        [<DataMember>]
        member val Description:String = null with get,set

        [<DataMember>]
        member val Quantity:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Rate:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Discount:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Total:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Time:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Completed:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val CompletedDate:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val Technician:String = null with get,set

        [<DataMember>]
        member val Notes:String = null with get,set

        [<DataMember>]
        member val Category:Int32 = new Int32() with get,set

        [<DataMember>]
        member val CategoryDescription:String = null with get,set

        [<DataMember>]
        member val TimerActive:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val TimerStartTime:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type DepositInfo() = 
        [<DataMember>]
        member val OriginalAmount:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Amount:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val RefNumber:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type TicketInfo() = 
        [<DataMember>]
        member val Terms:Int32 = new Int32() with get,set

        [<DataMember>]
        member val PoNumber:String = null with get,set

        [<DataMember>]
        member val ReturnAuthorizationNumber:String = null with get,set

        [<DataMember>]
        member val Status:String = null with get,set

        [<DataMember>]
        member val ApprovedAmount:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val TotalDue:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Subtotal:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Tax1:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Tax2:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val ApprovedDate:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val BilledDate:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val Contact:String = null with get,set

        [<DataMember>]
        member val Category:Int32 = new Int32() with get,set

        [<DataMember>]
        member val Services:ResizeArray<ServiceInfo> = new ResizeArray<ServiceInfo>() with get,set

        [<DataMember>]
        member val CategoryDescription:String = null with get,set

        [<DataMember>]
        member val SubCategory:Int32 = new Int32() with get,set

        [<DataMember>]
        member val SubCategoryDescription:String = null with get,set

        [<DataMember>]
        member val Item:String = null with get,set

        [<DataMember>]
        member val ItemDescription:String = null with get,set

        [<DataMember>]
        member val Manufacturer:String = null with get,set

        [<DataMember>]
        member val Notes:String = null with get,set

        [<DataMember>]
        member val Timestamp:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val SoldToCustomerAcct:Int32 = new Int32() with get,set

        [<DataMember>]
        member val BillToCustomerAcct:Int32 = new Int32() with get,set

        [<DataMember>]
        member val Model:String = null with get,set

        [<DataMember>]
        member val StLoc:String = null with get,set

        [<DataMember>]
        member val TaxLoc:String = null with get,set

        [<DataMember>]
        member val RefNumber:String = null with get,set

        [<DataMember>]
        member val MasterNumber:String = null with get,set

        [<DataMember>]
        member val Invoiced:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val Deposits:ResizeArray<DepositInfo> = new ResizeArray<DepositInfo>() with get,set

        [<DataMember>]
        member val SoldToCustomerName:String = null with get,set

        [<DataMember>]
        member val BillToCustomerName:String = null with get,set

        [<DataMember>]
        member val ShipToName:String = null with get,set

        [<DataMember>]
        member val ShipToId:Nullable<Int64> = new Nullable<Int64>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type ServiceTicketFullDetailsResponse() = 
        inherit BaseResponse()
        [<DataMember>]
        member val Tickets:ResizeArray<TicketInfo> = new ResizeArray<TicketInfo>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseRequest() = 
        ///<summary>
        ///This is your AIM API Key provided by Tri-Tech
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")>]
        member val ApiKey:String = null with get,set

        [<DataMember>]
        [<ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")>]
        member val OAuthToken:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseSecureRequest() = 
        inherit BaseRequest()
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")>]
        member val Token:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")>]
        member val DeviceId:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")>]
        member val AppId:String = null with get,set

    ///<summary>
    ///ServiceTicketFullDetailsRequires active-e Service Tickets Service
    ///</summary>
    [<DataContract>]
    [<AllowNullLiteral>]
    type ServiceTicketFullDetailsRequest() = 
        inherit BaseSecureRequest()
        [<DataMember>]
        member val Acct:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember>]
        member val RefNumber:String = null with get,set

        [<DataMember>]
        member val ChangedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

F# ServiceTicketFullDetailsRequest DTOs

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

HTTP + OTHER

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: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}